templates/README.md.tt
# <%= config[:project].capitalize %>
TODO: Write a gem description
## Installation
Add this line to your application's Gemfile:
gem '<%= config[:project] %>'
And then execute:
$ bundle
Or install it yourself as:
$ gem install <%= config[:project] %>
## Usage
TODO: Write usage instructions here
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Testing
TODO: Add information specific to your gem's test suite.
The Rakefile comes with several convenience tasks for running tests as well. By rake task:
+ `spec`: Runs all rspec tests in the spec directory.
+ `yard`: Generates yard documentation.
+ `rubocop`: Runs rubocop.
+ `run_guards`: Runs all guards.
`run_guards` is the one you're most likely to want to run, since it runs all the other test-related tasks.