Updated Readme

README.md

@@ -1,25 +1,22 @@
-# PrayermateApi
+# PrayerMateApi
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/prayermate_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is an API for working with the [PrayerMate platform](https://www.prayermate.net/). 
 
-TODO: Delete this and the text above, and describe your gem
+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:
 
 ```ruby
-gem 'prayermate_api'
+gem 'prayermate_api', git: 'git://github.com/UsAndRufus/prayermate_api.git'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install prayermate_api
-
 ## Usage
 
 TODO: Write usage instructions here
@@ -32,12 +29,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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](http://contributor-covenant.org) code of conduct.
+~~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](http://contributor-covenant.org) code of conduct.~~
+
+Currently development and usage is internal. Contact [[email protected]](mailto:[email protected]) to get involved.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## 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](https://github.com/[USERNAME]/prayermate_api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PrayermMteApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/prayermate_api/blob/master/CODE_OF_CONDUCT.md).