Sha256: a363942e5dce7bb46d06a1efadf157933dd967ba52bea0defe694b0e9a5b3339

Contents?: true

Size: 1.69 KB

Versions: 2

Compression:

Stored size: 1.69 KB

Contents

# Centaman

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/centaman`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'centaman'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install centaman

## Usage

TODO: Write usage instructions here

## Required Environment Variables

This gem assumes the following environment variables are defined by the application

- CENTAMAN_API (Centaman API endpoint, ex: https://taxi.centaman.net/CentamanAPI)
- API_USERNAME (Centaman API username)
- API_PASSWORD (Centaman API password)
- FIXIE_URL (Optional. Used with FIXIE proxy to route outbound requests through a set of static IP addresses)

## 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/[USERNAME]/centaman.


## License

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

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
centaman-0.1.1 README.md
centaman-0.1.0 README.md