Skip to content

Commit

Permalink
Update installation instructions (#63)
Browse files Browse the repository at this point in the history
* Update README.md with note to include gem from GitHub

The rubygems version isn't kept up to date and is currently broken in rails 5.0.
When included directly from github master branch, it works without problems.

* Create separate installation section in README

* Clarify wording about rubygems version

* Use github shorthand
  • Loading branch information
stevejackson authored and dhh committed Jan 17, 2017
1 parent abe02c1 commit 3509073
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,20 @@ even JavaScript Sprinkles (that all continues to live in app/assets).

It's designed to work with Rails 5.1+ and makes use of the [Yarn](https://yarnpkg.com/) dependency management
that's been made default from that version forward.
It's also currently compatible with Rails 5.0 stable but there's absolutely no warranty
it will still be in the future.

## Installation

Webpacker is currently compatible with Rails 5.0 stable, but there's no guarantee it will still be
in the future.

You can either make use of Webpacker during setup of a new application with `--webpack`
or you can add the gem and run `bin/rails webpacker:install` in an existing application.

As the rubygems version isn't promised to be kept up to date until the release of Rails 5.1, you may want to include the gem directly from GitHub:

```ruby
gem 'webpacker', github: 'rails/webpacker'
```

## Binstubs

Expand Down

0 comments on commit 3509073

Please sign in to comment.