Sha256: 33725941770ebb850333fd8ef65a2e591fa50dff477c55d93f91ccfded3bd5af

Contents?: true

Size: 1.79 KB

Versions: 2

Compression:

Stored size: 1.79 KB

Contents

# Devrant

This gem is the unnofficial wrapper for the devRant API. It provides convinience methods and an interface to easily integrate devRant into
your ruby projects.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'devrant'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install devrant

## Usage

Include this gem into your project:

```ruby
require 'devrant'
```

Initialize the devRant client:

```ruby 
devRant = Devrant::Api.new
```

### Rants

Getting all rants:

```ruby
require 'devrant'

devRant = Devrant::Api.new

devRant.rants.get_rants
```

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alexdovzanyn/devrant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Devrant project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexdovzhanyn/devrant/blob/master/CODE_OF_CONDUCT.md).

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
devrant-0.0.2 README.md
devrant-0.0.1 README.md