Sha256: 3e433b33c94fd23a2505846be0ed6c6c96cc012c7574b860f677b6cd371751c4
Contents?: true
Size: 1.42 KB
Versions: 9
Compression:
Stored size: 1.42 KB
Contents
# CirroIO::Client
This gem provides access to the [Cirro REST API](https://staging.cirro.io/api-docs/v1#cirro-api-documentation).
[](https://circleci.com/gh/test-IO/cirro-ruby-client/tree/master)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cirro-ruby-client'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install cirro-ruby-client
## Configuration
You need to create an initializer file in config/initializers.
```ruby
CirroIO::Client.configure do |c|
c.app_id 'WULnc6Y0rlaTBCSiHAb0kGWKFuIxPWBXJysyZeG3Rtw'
c.private_key_path './storage/cirro.pem'
c.site 'https://api.staging.cirro.io'
end
```
## 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).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Version data entries
9 entries across 9 versions & 1 rubygems