Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.99 KB

README.md

File metadata and controls

65 lines (40 loc) · 1.99 KB
Raw

hotline

build

Ruby gem for programattic portions of the Hotline protocol. I'm starting with the tracker client but may add more functionality in time.

Implementation status:

  • Server
    • Server
    • Client
  • Tracker
    • Server
    • Client

Installation

Add this line to your application's Gemfile:

gem 'hotline'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hotline

Usage

At this point, only the tracker client is written:

Tracker Client

require 'hotline/tracker/client'

client = Hotline::Tracker::Client.new("hltracker.com")
client.fetch
client.servers.each do |server|
    puts server.name
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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]/hotline. 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.

Code of Conduct

Everyone interacting in the Hotline project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.