Skip to content

Latest commit

 

History

History
86 lines (42 loc) · 2.42 KB

README.md

File metadata and controls

86 lines (42 loc) · 2.42 KB
Raw

EspressoPath

Welcome to your EspressoPath! Espresso Path is GeoPath API Ruby Wrapper

WARNING - EXTREME ALPHA

Installation

Add this line to your application's Gemfile:

gem 'espresso_path', '~> 0.1.7'

And then execute:

$ bundle

Or install it yourself as:

$ gem install espresso_path

Documentation

EspressoPath Docs

Testing

  1. Create .env in the root directory

  2. Add the following environment variables

    ESPRESSO_PATH_USER_NAME=YourEmail ESPRESSO_PATH_PASSWORD=YourPassword

  3. Run tests with

    rspec

Usage

TODO: Write usage instructions here

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/kickinespresso/espresso_path. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

When making pull requests, please be sure to update the CHANGELOG.md with the corresponding changes.

License

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

Sponsors

This project is sponsored by KickinEspresso

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Code of Conduct

Please refer to the Code of Conduct for details

RubyGems

EspressoPath on RubyGems

Release Process

RELEASING.md