Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 1.42 KB

README.md

File metadata and controls

46 lines (26 loc) · 1.42 KB
Raw

Gem Build Status Inline docs

CWSrb

CWSrb is a simple API wrapper for ConWorkShop.

Dependencies

  • Ruby 2.1+

Installation

Add this line to your application's Gemfile:

gem 'cwsrb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cwsrb

Usage

TODO (I swear I'll fill this out)

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/unleashy/cwsrb. Don't forget to use rubocop!

License

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