misfitsmk/readme

README markdown template

Application Title Goes Here

By [Author name](author URL goes here).

[](Code Climate URL goes here)

Description

Application Name Here description can be listed here.

Installation

Add it to your Gemfile:

gem 'my_example_gem'

Run the following command to install it:

bundle install

Run the generator:

rails generate my_example_gem:install

Usage

Usage explanation goes here

<%= your_code_goes @here do |f| %>
  <%= f.input :example %>
  <%= f.input :example %>
  <%= f.button :example %>
<% end %>

Configuration

This block of text should explain how to configure your application:

rails generate my_example_gem:install

Information

Screenshots of your application below:

Known Issues

If you discover any bugs, feel free to create an issue on GitHub fork and send us a pull request.

[Issues List](Github Issues List URL goes here).

Authors

• Your Name (Your Github URL goes here)
• Additional Author's name (Their Github URL goes here)

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

License

Your Licensing Information goes here. Example: MIT/X11.