Courbe

Courbe is an API wrapper for Misskey, written in Crystal. It should be compatible with most, if not all, Misskey forks, and is tested using an instance of Sharkey.

Be sure to run crystal doc and look through the documentation of Courbe or you might get a little confused. Since Misskey's API has very minimal documentation (or sometimes none at all), I decided to detail each method as much as possible so you won't have to get confused like I did. Any contributions to that are especially welcome.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
  courbe:
    github: whimsicorp/courbe

  2. Run shards install

Usage

require "courbe"

TODO Write usage instructions here

Development

TODO Write development instructions here

Contributing

  1. Fork it (https://github.com/whimsicorp/courbe/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors