Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 4.3 KB

README.md

File metadata and controls

87 lines (61 loc) · 4.3 KB

LetterGroup

Organize data results from raw sql queries (as with PGresult, or Dossier) intelligently.

Project LetterGroup
gem name letter_group
license MIT
expert support Get help on Codementor
download rank Total Downloads
version Gem Version
dependencies Dependency Status
code quality Code Climate
inline documenation Inline docs
continuous integration Build Status
test coverage Coverage Status
homepage on Github.com
documentation on Rdoc.info
live chat Join the chat at https://gitter.im/pboling/letter_group
Spread ♡ⓛⓞⓥⓔ♡ 🌏, 👼, :shipit:, Tweet Peter, 🌹

See specs for examples.

No view code yet, for now just the logic.

Installation

Add this line to your application's Gemfile:

gem 'letter_group'

And then execute:

$ bundle

Or install it yourself as:

$ gem install letter_group

Usage

See specs for usage examples.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

Maintenance

To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Versioning

This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency 'letter_group', '~> 0.1'

Contributing

  1. Fork it ( https://github.com/[my-github-username]/letter_group/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