ReportingCloud Ruby SDK

This is the official Ruby SDK for the ReportingCloud Web API. It is authored, maintained and fully supported by Text Control.

www.reporting.cloud

Before using ReportingCloud, please sign up to the service:

portal.reporting.cloud

Installation

Add this line to your application's Gemfile:

gem 'txtextcontrol-reportingcloud'

And then execute:

$ bundle

Or install it yourself as:

$ gem install txtextcontrol-reportingcloud

API documentation (YARD)

All the source code in this library is documented using YARD.

You can read the API documentation online, or build it yourself, using the following command:

$ yard doc

The resultant set of HTML files will be written to ~/txtextcontrol-reportingcloud-ruby/doc.

If you don't have YARD already installed, you can install it with RubyGems with the following command:

$ gem install yard

Contributing

Bug reports and pull requests are welcome on GitHub at github.com/TextControl/txtextcontrol-reportingcloud-ruby.