diff options
Diffstat (limited to 'vendor/gems/bundler-checksum/README.md')
-rw-r--r-- | vendor/gems/bundler-checksum/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/vendor/gems/bundler-checksum/README.md b/vendor/gems/bundler-checksum/README.md new file mode 100644 index 00000000000..1420dc49b94 --- /dev/null +++ b/vendor/gems/bundler-checksum/README.md @@ -0,0 +1,32 @@ +# bundler-checksum + +Bundler patch for verifying local gem checksums + +## Install + +Add the following to your Gemfile: + +``` +if ENV['BUNDLER_CHECKSUM_VERIFICATION_OPT_IN'] # this verification is still experimental + require 'bundler-checksum' + Bundler::Checksum.patch! +end +``` + +## Usage + +Once the gem is installed, bundler-checksum will verify gems before +installation. + +If a new or updated gem is to be installed, the remote checksum of that gem is stored in `Gemfile.checksum`. +Checksum entries for other versions of the gem are removed from `Gemfile.checksum`. + +If a version of a gem is to be installed that is already present in `Gemfile.checksum`, the remote and local +checksums are compared and an error is prompted if they do not match. + +Gem checksums for all platforms are stored in `Gemfile.checksum`. +When `bundler-checksum` runs it will only verify the checksum for the platform that `bundle` wants to download. + + +## Development + |