Sha256: d379109b864866ec29519ca37e76ff37c96c20b3b4677e7ca4900fa24116e484

Contents?: true

Size: 1.6 KB

Versions: 1

Compression:

Stored size: 1.6 KB

Contents

## <%= MiscUtils.camel_case(name) %>

[![Gem Version](https://badge.fury.io/rb/<%= name %>.svg)](http://badge.fury.io/rb/<%= name %>)
[![Dependency Status](https://gemnasium.com/<%= options[:github_id] %>/<%= name %>.png)](https://gemnasium.com/<%= options[:github_id] %>/<%= name %>)
[![Code Climate](https://codeclimate.com/github/<%= options[:github_id] %>/<%= name %>.png)](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][]
- 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
[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

1 entries across 1 versions & 1 rubygems

Version Path
gem_bootstrap-0.0.1 templates/README.md