README.md in bundler-download-1.3.1 vs README.md in bundler-download-1.3.2
- old
+ new
@@ -1,6 +1,6 @@
-# bundler-download - Bundler Plugin - v1.3.1
+# bundler-download - Bundler Plugin - v1.3.2
[](http://badge.fury.io/rb/bundler-download)
Bundler plugin for auto-downloading extra gem files (e.g. large file downloads) specified in [`Downloadfile`](#downloadfile) after `bundle install`
## Background
@@ -66,28 +66,30 @@
2. `to:` keyword arg: mentions a local download path relative to the gem installation directory (e.g. 'vendor' or 'lib/ai/data'). It automatically creates the path with all its subdirectories if it does not already exist. If left empty, then the file is downloaded to the gem directory root path.
3. `os:` keyword arg (value: `mac` / `windows` / `linux`): limits the operating system under which the download is made. It is `nil` by default, allowing the download to occur in all operating systems.
## App Bundler Plugin Instructions
-In plugin mode, all gems declared in Gemfile are inspected for presence of Downloadfile regardless of what group they belong to.
+In plugin mode, all gems declared in `Gemfile` are inspected for presence of `Downloadfile` regardless of what group they belong to.
-An app can depend on a gem that has a `Downloadfile` by adding the `bundler-download` plugin first (or manually installing via `bundle plugin install bundler-download`) and then including the gem in `Gemfile` like it normally would:
+An app can depend on a gem that has a `Downloadfile` by including in `Gemfile` and running:
```
-plugin 'bundler-download'
-
-gem 'some_gem_with_downloadfile'
+bundle
```
-Afterwards, run:
+Afterwards install the `bundler-download` plugin via:
```
-bundle install
+bundle plugin install bundler-download
```
-(run one extra time if you don't have the `bundler-download` plugin installed yet since the first run would just install the plugin and subsequent runs would activate it)
+Finally, `bundle` one extra time to activate the `bundler-download` plugin:
+```
+bundle
+```
+
You should see something like this:
```
$ bundle
Using array_include_methods 1.0.2
@@ -100,11 +102,11 @@
Using strings-ansi 0.1.0
Using tty-cursor 0.7.1
Using tty-screen 0.8.1
Using unicode-display_width 1.7.0
Using tty-progressbar 0.17.0
-Using bundler-download 1.3.1
+Using bundler-download 1.3.2
Using facets 3.1.0
Using glimmer 1.0.0
bundle-download plugin gem-after-install-all hook:
Processing /Users/User/.rvm/gems/ruby-2.7.1@tmp/gems/glimmer-1.0.0/Downloadfile
Download URL: https://equo-chromium-cef.ams3.digitaloceanspaces.com/rls/repository/plugins/com.make.chromium.cef.gtk.linux.x86_64_0.4.0.202005172227.jar
@@ -115,11 +117,11 @@
Download size: 54070695
Download path: /Users/User/.rvm/gems/ruby-2.7.1@tmp/gems/glimmer-1.0.0/cef/com.make.chromium.cef.cocoa.macosx.x86_64_0.4.0.202005172227.jar
Downloading 26% ( 59s ) [============== ]
```
-After the initial download of files, running `bundle install` again will keep existing downloads without overwriting them unless you use the [`bundle-download`](#bundler-download-command) command to manually redownload files again.
+After the initial download of files, running `bundle` again will keep existing downloads without overwriting them unless you use the [`bundle-download`](#bundler-download-command) command to manually redownload files again.
### Bundler Download Command
If you would like to redownload files for all gems again, overwriting existing downloads, simply run:
@@ -163,10 +165,10 @@
```
Prints:
```
-== bundler-download - Bundler Plugin - v1.3.1 ==
+== bundler-download - Bundler Plugin - v1.3.2 ==
Commands/Subcommands/Options:
bundle download help # Provide help by printing usage instructions
bundle download usage # (alias for help)
bundle download start # Start downloads for current operating system