Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 1.13 KB

Readme.mdown

File metadata and controls

48 lines (28 loc) · 1.13 KB

Split::API

An extension to Split to provide a REST-based JSON API.

Install

Requirements

The split gem and its dependencies.

Setup

gem install split-api

Usage

TODO

TODO

Javascript library for communicating with api

Session sharing

note to be added about sharing sessions between apps

Contributing

Source hosted at GitHub. Report Issues/Feature requests on GitHub Issues.

Tests can be ran with rake spec

Please conform to the Code of Conduct.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

License

Copyright (c) 2013-2018 Andrew Nesbitt. See LICENSE for details.