omniauth-mapsme/README.md
2016-08-30 12:42:28 -04:00

19 lines
928 B
Markdown

# Omniauth MAPS.ME
This is a gem to connect to the MAPS.ME passport service via OAuth2. It requires OmniAuth.
## Usage
I'm too lazy to write this section, please use the code from [omniauth-osm examples](https://github.com/sozialhelden/omniauth-osm#how-to-use-it),
replacing `osm` with `mapsme`.
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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).
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).