Skip to content

swarley/vox

Repository files navigation

Vox

Maintainability Test Coverage Gem Version Inline docs

A gem for interacting with the Discord API. Intends to cover the entire API, have high spec coverage, complete documentation coverage, and be as modular as possible with room for flexibility of use at every level.

Installation

Add this line to your application's Gemfile:

gem 'vox'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install vox

Usage

Currently only the HTTP API has been implemented, and it does not return abstracted objects. Rather it is simply a client to assist in making requests and handling rate limiting.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/swarley/vox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Vox project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.