Sha256: 4075256712c7e267ba3087c2d9aaf78aae4d1bc185b3bdf5b3d4f0af0940d980

Contents?: true

Size: 1.99 KB

Versions: 1

Compression:

Stored size: 1.99 KB

Contents

# Omniauth Younility Strategy

Version 1.0.0

OAuth2 strategy for [`omniauth`](http://rubygems.org/gems/omniauth) and
[Younility](http://www.younility.com/).

## Installation

Add this line to your application's Gemfile:

```sh
gem 'omniauth-younility'
```

And then execute:

```sh
$ bundle
```

Or install it yourself as:

```sh
$ gem install omniauth-younility
```

## Demo

You can see a demo of usage at [our heroku site](https://signatron.herokuapp.com)

## Usage

The API is currently only in private beta. Usage instructions to follow.

For now, see the source of the demo app at [our github site](https://github.com/YounilityInc/signature_generator).

### Ruby

For use in a _Sinatra_ or _Ruby on Rails_ application:

```ruby
# config/initializers/omniauth.rb
module OmniAuth
  module Strategies
    # tell OmniAuth to load the Younility strategy
    autoload :Younility, 'omniauth/strategies/younility'
  end
end

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :younility, ENV['YOUNILITY_APP_ID'], ENV['YOUNILITY_APP_SECRET']
end
```

## 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
1. Fork it ( http://github.com/YounilityInc/omniauth-younility/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## License

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

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
omniauth-younility-1.0.0 README.md