1.8 KiB
Outliner
A simple HTTParty based wrapper for the Outline API.
Installation
Add this line to your application's Gemfile:
gem 'outliner'
And then execute:
$ bundle
Or install it yourself as:
$ gem install outliner
Usage
The API Client automatically picks up the Token from the OUTLINE_TOKEN
environment variable. All the API calls are available with the .
replaced with a _
in the method name. So if you need to call the collections.remove_user
API, use the collections_remove_user
method.
require 'outliner'
client = Outliner.new('https://knowledge.example.com')
pp client.auth_info
pp client.collections_list(offset: 0, limit: 10)
Development
After checking out the repo, run bin/setup
to install dependencies. 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/captn3m0/outliner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Code of Conduct
Everyone interacting in the Outliner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
License
Licensed under the MIT License. See LICENSE file for details.