Skip to content
This repository has been archived by the owner on Jun 11, 2022. It is now read-only.
/ chatmeter Public archive

A ruby wrapper for the chatmeter API

License

Notifications You must be signed in to change notification settings

G5/chatmeter

Repository files navigation

Chatmeter

A ruby api wrapper for chatmeters REST API http://newapi.chatmeter.com/

Installation

Add this line to your application's Gemfile:

gem 'chatmeter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chatmeter

Usage

require 'chatmeter'
chatmeter = Chatmeter::API.new(:username => USERNAME, :password => PASSWORD)

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/G5/chatmeter. 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.

License

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