README.md in omniauth-chatwork-0.1.0.beta1 vs README.md in omniauth-chatwork-0.1.0

- old
+ new

@@ -1,10 +1,14 @@ # OmniAuth::Chatwork -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/omniauth/chatwork`. To experiment with that code, run `bin/console` for an interactive prompt. +OmniAuth strategy for ChatWork -TODO: Delete this and the text above, and describe your gem +[![Gem Version](https://badge.fury.io/rb/omniauth-chatwork.svg)](https://badge.fury.io/rb/omniauth-chatwork) +[![Build Status](https://travis-ci.org/sue445/omniauth-chatwork.svg?branch=master)](https://travis-ci.org/sue445/omniauth-chatwork) +[![Maintainability](https://api.codeclimate.com/v1/badges/c28dcf54cef09425c10d/maintainability)](https://codeclimate.com/github/sue445/omniauth-chatwork/maintainability) +[![Coverage Status](https://coveralls.io/repos/github/sue445/omniauth-chatwork/badge.svg)](https://coveralls.io/github/sue445/omniauth-chatwork) +[![Dependency Status](https://gemnasium.com/badges/github.com/sue445/omniauth-chatwork.svg)](https://gemnasium.com/github.com/sue445/omniauth-chatwork) ## Installation Add this line to your application's Gemfile: @@ -27,10 +31,14 @@ # or provider :chatwork, ENV["CLIENT_ID"], ENV["CLIENT_SECRET"], scope: ["users.all:read", "rooms.all:read_write", "contacts.all:read_write"] end ``` +And register `https://YOURSERVER/auth/chatwork/callback` to *Redirect URI* + +![redirect_uri](img/redirect_uri.png) + ## Configuring * `scope` : `String` or `Array` * A list of permissions you want to request from the user * default is `["rooms.all:read_write"]` * see Appendix scope list of http://download.chatwork.com/ChatWork_API_Documentation.pdf (en) or http://developer.chatwork.com/ja/oauth.html#secAppendix (ja) @@ -88,9 +96,13 @@ 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). ### Run dummy app +At first, register `https://127.0.0.1:4567/auth/chatwork/callback` to *Redirect URI* + +![redirect_uri](img/redirect_uri.png) + ```bash cp .env.example .env vi .env bundle exec ruby spec/dummy/app.rb