Sha256: 4db65a75ba860e58269db04945536e025fe99585911cdb00562461364a718615
Contents?: true
Size: 1.57 KB
Versions: 9
Compression:
Stored size: 1.57 KB
Contents
# Cordial
[ ](https://app.codeship.com/projects/287555)
[](https://badge.fury.io/rb/cordial)
[](https://codeclimate.com/github/MeUndies/cordial/maintainability)
[](https://codeclimate.com/github/MeUndies/cordial/test_coverage)
A ruby gem to interact with the [Cordial API](https://api.cordial.io/docs/v1/).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cordial'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install cordial
```ruby
Cordial.configure do |config|
config.api_key = 'your-api-key'
end
```
## Usage
```ruby
Cordial::Contact.create(email: 'hello@world')
```
## 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!
Version data entries
9 entries across 9 versions & 1 rubygems