Skip to content
This repository has been archived by the owner on Dec 21, 2019. It is now read-only.

Latest commit

 

History

History
41 lines (23 loc) · 1.61 KB

README.md

File metadata and controls

41 lines (23 loc) · 1.61 KB
Raw

Aker - Projects client gem

Build Status Maintainability Test Coverage

A JSON API Client for Aker's study application.

Installation

This gem currently uses the version of json_api_client from Sanger's github repo. Since gemspec does not support git depenencies, this gem should built using bundle.

Add this line to your application's Gemfile:

gem 'aker-study-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install aker-study-client

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/[USERNAME]/aker-study-client.