Skip to content

Latest commit

 

History

History
58 lines (26 loc) · 1.51 KB

README.rdoc

File metadata and controls

58 lines (26 loc) · 1.51 KB

<img src=“https://travis-ci.org/thecity/thecity-admin-ruby.svg?branch=master” alt=“Build Status” /> <img src=“https://coveralls.io/repos/thecity/thecity-admin-ruby/badge.png” alt=“Coverage Status” />

The City Admin API

This Ruby project is an API wrapper for TheCity Admin API (api.onthecity.org)

Install / Setup

Installing the gem

gem install the-city-admin

To add it to your Gemfile

gem 'the-city-admin', :require => 'the_city_admin'

Add your church’s City API Token and API Key to [RAILS_ROOT]/config/initializers/thecity_config.rb

THECITY_KEY = '**** YOUR CITY API KEY ****'
THECITY_TOKEN = '**** YOUR CITY API TOKEN ****'

Next you will need to initialize a connection

TheCity::AdminApi.connect(THECITY_KEY, THECITY_TOKEN)

Example usage

Checkout the examples folder.

Additional resources

License

This project is released under the MIT license (see LICENSE).

This project is maintained by Wes Hays (github.com/weshays) and Jason Hagglund (github.com/TheMetalCode).

Contributors

Chris Morris: github.com/chrismo

Want to Contribute?

If you would like to get involved in this project, then please fork the project. Make changes, add features, write some tests, and then send us a pull request.