Contents

# Convox API Client

Thin wrapper around the Convox console API found at:

```ruby
https://convox.com/api
```

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'convox_api_client'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install convox_api_client

## Usage

Create a new ```Convox::API::Client``` with your API key and call the wrapper methods.

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/HarmonyMobile/convox_api_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
convox_api_client-0.3.0	README.md
convox_api_client-0.2.3	README.md
convox_api_client-0.2.2	README.md
convox_api_client-0.2.1	README.md
convox_api_client-0.2.0	README.md