README.md in omniauth-msunet-1.0.2 vs README.md in omniauth-msunet-1.1.0

- old
+ new

@@ -1,17 +1,22 @@ -# OmniAuth MSUnet +# OmniAuth MSU NetID -This is the official OmniAuth strategy gem for authenticating to [Michigan State University](http://www.msu.edu) MSUnet using OAuth2. To use this gem you'll need the following: +[![Build Status](https://travis-ci.org/Michigan-State-University/omniauth-msunet.svg?branch=master)](https://travis-ci.org/Michigan-State-University/omniauth-msunet) +[![Dependency Status](https://gemnasium.com/Michigan-State-University/omniauth-oauth2.svg)](https://gemnasium.com/Michigan-State-University/omniauth-oauth2) -* Contact MSU IT Services at 517-432-6200 to request to register your application. -* Provide IT Services with a callback URL, which is where to send successful MSUnet authentication requests back to your application. Note: this must be a HTTPS address. +## Description + +This is the official OmniAuth strategy gem for authenticating to [Michigan State University](https://msu.edu) MSU NetID using OAuth2. To use this gem you'll need the following: + +* Contact MSU Information Technology Service Desk at 517-432-6200 to request to register your application, or complete the [OAuth 2.0 request form] (https://tech.msu.edu/network/authentication-authorization) +* Provide MSU Information Technology Identity Management with a callback URL, which is where to send successful MSU NetID authentication requests back to your application. Note: this must be a HTTPS address. * Receive a `client_id` token and `client_secret` token specific for your application. ## Installation To install this gem you need to add it to your Gemfile as follows: -```gem 'omniauth-msunet', :git => 'https://gitlab.msu.edu/tm/omniauth-msunet.git'``` +```gem 'omniauth-msunet'``` ## Basic Usage If this is your applications first OmniAuth strategy then you will need to create the file config/initializers/omniauth.rb, otherwise update your existing one. @@ -40,12 +45,36 @@ "info":{ "name":"John Sparty", "email":"sparty@msu.edu", "first_name":"John", "last_name":"Sparty", - "description":"MSUNet OAuth2 Auth-n" + "description":"MSU NetID OAuth2 Auth-n" } } +``` + +## Development + +1) Clone the repository +2) Write some tests +3) Make them pass +4) Request a pull + +### Testing + +`bundle exec rspec` + +### Releasing + +Use the [version](https://github.com/stouset/version) gem. See `bundle exec +rake -T version` for commands. Bumping the version will change the `VERSION` +file, commit the changes, and create a tag. You can then push the tag to your +remote: + +``` +bundle exec rake version:bump # create a minor version bump +git push # push code changes +git push origin $(bundle exec rake version) # push new tag ``` ## License Please see the LICENSE.md file.