32 lines
617 B
Plaintext
32 lines
617 B
Plaintext
|
# <%=config[:constant_name]%>
|
||
|
|
|
||
|
|
TODO: Write a gem description
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Add this line to your application's Gemfile:
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
gem '<%=config[:name]%>'
|
||
|
|
```
|
||
|
|
|
||
|
|
And then execute:
|
||
|
|
|
||
|
|
$ bundle
|
||
|
|
|
||
|
|
Or install it yourself as:
|
||
|
|
|
||
|
|
$ gem install <%=config[:name]%>
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
TODO: Write usage instructions here
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
1. Fork it ( https://github.com/[my-github-username]/<%=config[:name]%>/fork )
|
||
|
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
||
|
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
||
|
|
4. Push to the branch (`git push origin my-new-feature`)
|
||
|
|
5. Create a new Pull Request
|