Proverbs

Let not mercy and truth forsake thee: bind them about thy neck; write them upon the table of thine heart.

    Proverbs 3:3

Installation

To get the latest stable release, add this line to your application's Gemfile:

gem 'proverbs'

To get the latest code:

gem 'proverbs', git: 'https://github.com/jeffnyman/proverbs'

After doing one of the above, execute the following command:

$ bundle

You can also install Tapestry just as you would any other gem:

$ gem install proverbs

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake spec:all to run the tests. The default rake command will run all tests as well as a RuboCop analysis. To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jeffnyman/proverbs. The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another test-supporting tool. As such, contributors are very much welcome but are expected to adhere to the Contributor Covenant code of conduct.

The Proverbs gem follows semantic versioning.

To contribute to Proverbs:

  1. Fork the project.
  2. Create your feature branch. (git checkout -b my-new-feature)
  3. Commit your changes. (git commit -am 'new feature')
  4. Push the branch. (git push origin my-new-feature)
  5. Create a new pull request.

Author

License

Proverbs is distributed under the MIT license. See the LICENSE file for details.