diff --git a/USAGE.md b/USAGE.md index aa76abe13..5b824efdb 100644 --- a/USAGE.md +++ b/USAGE.md @@ -43,7 +43,7 @@ The [package principles](https://en.wikipedia.org/wiki/Package_principles) page ## Getting started After including Packwerk in the Gemfile, you will first want to generate a binstub: -You can do this by running `bundle binstub packwerk`, which will generate a [binstub](https://bundler.io/man/bundle-binstubs.1.html#DESCRIPTION) for packwerk. +You can do this by running `bundle binstub packwerk`, which will generate a [binstub](https://bundler.io/man/bundle-binstubs.1.html#DESCRIPTION) at `bin/packwerk`. Then, you can generate the necessary files to get Packwerk running by executing: @@ -74,7 +74,9 @@ Packwerk reads from the `packwerk.yml` configuration file in the root directory. ## Setting up Spring -[Spring](https://github.com/rails/spring) is a preloader for Rails. Because `packwerk` loads `Rails`, it can be sped up dramatically by enabling spring. Packwerk supports the usage of Spring. To enable Spring, first run `bin/spring binstub packwerk` which will "springify" the generated binstub. Secondly, spring needs to know about the packwerk spring command when spring is loading. To do that, add `require 'packwerk/spring_command'` to the bottom of `config/spring.rb` in your application. +[Spring](https://github.com/rails/spring) is a preloader for Rails. Because `packwerk` loads `Rails`, it can be sped up dramatically by enabling spring. Packwerk supports the usage of Spring. +Firstly, spring needs to know about the packwerk spring command when spring is loading. To do that, add `require 'packwerk/spring_command'` to `config/spring.rb` in your application. +Secondly, to enable Spring, first run `bin/spring binstub packwerk` which will "springify" the generated binstub. ### Using a custom ERB parser