Skip to content
This repository has been archived by the owner on Mar 4, 2020. It is now read-only.

Latest commit

 

History

History
48 lines (28 loc) · 1.46 KB

README.md

File metadata and controls

48 lines (28 loc) · 1.46 KB

Lockme

Build Status Maintainability Test Coverage Gem

Lockme is a Ruby gem to interact with lockme.pl API.

Installation

Add this line to your application's Gemfile:

gem 'lockme'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lockme

Usage

After adding the gem you need to initialize it with your API key and secret

Lockme.api_key = '...'
Lockme.secret = '...'

If you wish to debug the requests sent set Lockme.logger to $stdout or Rails.logger if you use this gem inside a Rails app.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hajder/lockme.

License

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