Sha256: ba622e398cc619e54648507f1d831733810061cf68f276e59826a7e36e743fed
Contents?: true
Size: 1.93 KB
Versions: 4
Compression:
Stored size: 1.93 KB
Contents
= <%= module_name %>
{<img src="http://img.shields.io/travis/nepalez/<%= gem_name %>.svg?style=flat" alt="Bild Status" />}[https://travis-ci.org/nepalez/<%= gem_name %>]
{<img src="http://img.shields.io/codeclimate/github/nepalez/<%= gem_name %>.svg?style=flat" alt="Code Metrics" />}[https://codeclimate.com/github/nepalez/<%= gem_name %>]
{<img src="http://img.shields.io/gemnasium/nepalez/<%= gem_name %>.svg?style=flat" alt="Dependency Status" />}[https://gemnasium.com/nepalez/<%= gem_name %>]
{<img src="http://img.shields.io/coveralls/nepalez/<%= gem_name %>.svg?style=flat" alt="Coverage Status" />}[https://coveralls.io/r/nepalez/<%= gem_name %>]
{<img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License" />}[https://github.com/nepalez/<%= gem_name %>/blob/master/LICENSE.rdoc]
== About
Defines models of {TODO}.
Contains use cases for managing {TODO} and API for {TODO}
via json http requests.
=== Models
<tt><%= module_name %>::Something</tt>::
TODO: describe a model.
=== UseCases
<tt><%= module_name %>::DoSomething</tt>::
TODO: describe a use case.
=== REST API
See the { API Blueprint }[http://docs.<%= gem_name %>.apiary.io] for details.
=== Dependencies
<tt><%= module_name %>.get_something_name</tt>::
TODO: describe a dependency.
== Installation
Add this line to your application's Gemfile:
gem "<%= gem_name %>"
And then execute:
$ bundle
Or install it yourself as:
$ gem install <%= gem_name %>
Then run from a command line:
$ rails g users:install
This will create a <tt>config/initializers/<%= gem_name %>.rb</tt> with module settings.
Review the file and change default values.
== Contributing
1. Fork it ( https://github.com/nepalez/<%= gem_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
Version data entries
4 entries across 4 versions & 1 rubygems