Skip to content

Instantly share code, notes, and snippets.

@andreypronin

andreypronin/README.md

Created October 5, 2014 13:29
Show Gist options
  • Save andreypronin/4654a5c2e1f1045096a8 to your computer and use it in GitHub Desktop.
Save andreypronin/4654a5c2e1f1045096a8 to your computer and use it in GitHub Desktop.
Download ZIP
Gem README template
Raw
README.md

NOT FOR PUBLIC USE YET. ACTIVE INITIAL DEVELOPMENT IS IN PROGRESS.

TODO: Brief description. TODO: Describe the problem & the solution.

Build Status Coverage Status

Installation

Add this line to your application's Gemfile:

gem '<gem>'

And then execute:

$ bundle

Or install it yourself as:

$ gem install <gem>

Usage

TODO: Write usage instructions here

Versioning

Semantic versioning (http://semver.org/spec/v2.0.0.html) is used.

For a version number MAJOR.MINOR.PATCH, unless MAJOR is 0:

  1. MAJOR version is incremented when incompatible API changes are made,
  2. MINOR version is incremented when functionality is added in a backwards-compatible manner,
  3. PATCH version is incremented when backwards-compatible bug fixes are made.

Major version "zero" (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable. Furthermore, version "double-zero" (0.0.x) is not intended for public use, as even minimal functionality is not guaranteed to be implemented yet.

Dependencies

TODO: List gem dependencies here

Contributing

  1. Fork it ( https://github.com///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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment