Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.84 KB

README.md

File metadata and controls

43 lines (24 loc) · 1.84 KB

PrayerMateApi

This gem is an API for working with the PrayerMate platform.

PrayerMate is an app to help you pray and this API allows you interact with the platform. Currently, usage of the gem is restricted to internal use but we may open it up in future.

Installation

Add this line to your application's Gemfile:

gem 'prayermate_api', git: 'git://github.com/UsAndRufus/prayermate_api.git'

And then execute:

$ bundle

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also 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. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/usandrufus/prayermate_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Currently development and usage is internal. Contact [email protected] to get involved.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the PrayerMateApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.