Files
RNetrunnerDb/README.md
Tommy Parnell fbcf9e0b5a minor changes
2015-05-17 02:00:11 -04:00

50 lines
1.3 KiB
Markdown

# NetrunnerDb
Simple wrapper over netrunnerDb API
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'NetrunnerDb'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install NetrunnerDb
## Usage
```ruby
res = NetrunnerDb::HttpHandler.get_cards
res = NetrunnerDb::HttpHandler.get_card(01001)
res = NetrunnerDb::HttpHandler.get_sets
res = NetrunnerDb::HttpHandler.get_set("cc")
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
1. Fork it ( https://github.com/tparnell8/RNetrunnerDb/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## todo
* test things
* publish gem
* figure out ruby better
* who knows