Beat
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/beat
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Add this line to your application's Gemfile:
gem 'beat'
And then execute:
$ bundle
Or install it yourself as:
$ gem install beat
Usage
in order to use this gem:
create an account, get your api_token from settings. Create file config/initializers/beat.rb
in that file put the lines:
Beat.api_token = api_token
Beat.api_url = api_url
where api_token is the api_token for your user, and api_url is the url where you have the api set up.
To send beats use the line:
Beat.send("title")
where title is the title of one of your heartbeats
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/[USERNAME]/beat.
License
The gem is available as open source under the terms of the MIT License.