summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTatsuhiko Miyagawa <miyagawa@bulknews.net>2013-08-05 10:18:07 -0700
committerTatsuhiko Miyagawa <miyagawa@bulknews.net>2013-08-05 10:18:07 -0700
commit1785123444a4c9e1c8df4ef0418f93bc1e5dcdf0 (patch)
tree59c33605ef6695a372553489cf250f9414126295
parent475ce80e1d7b7bb3631aeea5e53bc197a995ffb7 (diff)
downloadcarton-1785123444a4c9e1c8df4ef0418f93bc1e5dcdf0.tar.gz
v1.0.3v1.0.3
-rw-r--r--Build.PL2
-rw-r--r--Changes4
-rw-r--r--META.json2
-rw-r--r--README.md31
-rw-r--r--lib/Carton.pm2
5 files changed, 25 insertions, 16 deletions
diff --git a/Build.PL b/Build.PL
index a07f18e..6d21140 100644
--- a/Build.PL
+++ b/Build.PL
@@ -18,7 +18,7 @@ my %module_build_args = (
"Tatsuhiko Miyagawa"
],
"dist_name" => "Carton",
- "dist_version" => "v1.0.2",
+ "dist_version" => "v1.0.3",
"license" => "perl",
"module_name" => "Carton",
"recommends" => {},
diff --git a/Changes b/Changes
index 9cb29cc..ce3e17c 100644
--- a/Changes
+++ b/Changes
@@ -2,6 +2,10 @@ Revision history for carton
{{$NEXT}}
+v1.0.3 2013-08-05 10:17:59 PDT
+ - Update obsolete docs
+ - Added missing docs to some commands
+
v1.0.2 2013-08-04 21:49:14 PDT
- Bump cpanm dependency to deal with old dists with ancient META.yml (tokuhirom)
diff --git a/META.json b/META.json
index f3691da..2790751 100644
--- a/META.json
+++ b/META.json
@@ -78,7 +78,7 @@
"web" : "https://github.com/miyagawa/carton"
}
},
- "version" : "v1.0.2",
+ "version" : "v1.0.3",
"x_contributors" : [
"Christian Walde <walde.christian@googlemail.com>",
"David Golden <dagolden@cpan.org>",
diff --git a/README.md b/README.md
index f2311a5..49893f4 100644
--- a/README.md
+++ b/README.md
@@ -30,27 +30,27 @@ run in an embedded perl use case such as mod\_perl.
# DESCRIPTION
carton is a command line tool to track the Perl module dependencies
-for your Perl application. The managed dependencies are tracked in a
-_cpanfile.snapshot_ file, which is meant to be version controlled, and the
-snapshot file allows other developers of your application will have the
-exact same versions of the modules.
+for your Perl application. Dependencies are declared using [cpanfile](http://search.cpan.org/perldoc?cpanfile)
+format, and the managed dependencies are tracked in a
+_cpanfile.snapshot_ file, which is meant to be version controlled,
+and the snapshot file allows other developers of your application will
+have the exact same versions of the modules.
# TUTORIAL
## Initializing the environment
-carton will use the _.carton_ directory for local configuration and
-the _local_ directory to install modules into. You're recommended to
-exclude these directories from the version control system.
+carton will use the _local_ directory to install modules into. You're
+recommended to exclude these directories from the version control
+system.
- > echo .carton/ >> .gitignore
> echo local/ >> .gitignore
> git add cpanfile.snapshot
> git commit -m "Start using carton"
## Tracking the dependencies
-You can manage the dependencies of your application via _cpanfile_.
+You can manage the dependencies of your application via `cpanfile`.
# cpanfile
requires 'Plack', 0.9980;
@@ -78,12 +78,16 @@ Once you've done installing all the dependencies, you can push your
application directory to a remote machine (excluding _local_ and
_.carton_) and run the following command:
- > carton install
+ > carton install --deployment
This will look at the _cpanfile.snapshot_ and install the exact same
versions of the dependencies into _local_, and now your application
is ready to run.
+The `--deployment` flag makes sure that carton will only install
+modules and versions available in your snapshot, and won't fallback to
+query for CPAN Meta DB for missing modules.
+
## Bundling modules
carton can bundle all the tarballs for your dependencies into a
@@ -96,9 +100,10 @@ will bundle these tarballs into _vendor/cache_ directory, and
> carton install --cached
-will install modules using this local cache. This way you can avoid
-querying for a database like CPAN Meta DB or CPAN mirrors upon
-deployment time.
+will install modules using this local cache. Combined with
+`--deployment` option, you can avoid querying for a database like
+CPAN Meta DB or downloading files from CPAN mirrors upon deployment
+time.
# COMMUNITY
diff --git a/lib/Carton.pm b/lib/Carton.pm
index 5f7cd24..bb4f041 100644
--- a/lib/Carton.pm
+++ b/lib/Carton.pm
@@ -1,7 +1,7 @@
package Carton;
use strict;
use 5.008_005;
-use version; our $VERSION = version->declare("v1.0.2");
+use version; our $VERSION = version->declare("v1.0.3");
1;
__END__