Sha256: ea1847af5676cc8af3c8d083e3f118f80f407409fab892e218837b08cb2b929e
Contents?: true
Size: 1.73 KB
Versions: 8
Compression:
Stored size: 1.73 KB
Contents
## <%= MiscUtils.camel_case(name) %>
[][gem]
[][gemnasium]
[][codeclimate]
[gem]: http://badge.fury.io/rb/<%= name %>
[gemnasium]: https://gemnasium.com/<%= options[:github_id] %>/<%= name %>
[codeclimate]: https://codeclimate.com/github/<%= options[:github_id] %>/<%= name %>
Quickly generate the starting template for creating CLI ruby gem.
Generated template contain the simplest possible structure so that we don't have
to start from scratch.
Features:
- Test with [minitest][]
- Build with the power of [Thor][]
- Debug with pry[pry][]
- Documentation with [yard][]
- Style check with [rubocop][]
- BDD/TDD with guard [guard][]
- Initial git manipulation using [grit][]
### Installation
Add this line to your application's Gemfile:
gem '<%= name %>'
And then execute:
$ bundle
Or install it yourself as:
$ gem install <%= name %>
### Usage
Use as library try
```ruby
require '<%= name %>'
include <%= MiscUtils.camel_case(name) %>
# then call the appropriate functions
```
### Contributing
1. Fork it
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 new Pull Request
[thor]: https://github.com/erikhuda/thor
[minitest]: https://github.com/seattlerb/minitest
[guard]: https://github.com/guard/guard
[yard]: https://github.com/lsegal/yard
[pry]: https://github.com/pry/pry
[rubocop]: https://github.com/bbatsov/rubocop
[grit]: https://github.com/mojombo/grit
Version data entries
8 entries across 8 versions & 1 rubygems