README.md in backlog_kit-0.16.0 vs README.md in backlog_kit-0.17.0
- old
+ new
@@ -1,12 +1,12 @@
# BacklogKit
[![Gem Version](https://badge.fury.io/rb/backlog_kit.svg)](http://badge.fury.io/rb/backlog_kit)
[![Build Status](https://travis-ci.org/emsk/backlog_kit.svg?branch=master)](https://travis-ci.org/emsk/backlog_kit)
-[![Coverage Status](https://coveralls.io/repos/emsk/backlog_kit/badge.svg?branch=master)](https://coveralls.io/r/emsk/backlog_kit)
+[![Build status](https://ci.appveyor.com/api/projects/status/no4jqaoimctfsejj?svg=true)](https://ci.appveyor.com/project/emsk/backlog-kit)
+[![Codecov](https://codecov.io/gh/emsk/backlog_kit/branch/master/graph/badge.svg)](https://codecov.io/gh/emsk/backlog_kit)
[![Code Climate](https://codeclimate.com/github/emsk/backlog_kit/badges/gpa.svg)](https://codeclimate.com/github/emsk/backlog_kit)
-[![Dependency Status](https://gemnasium.com/emsk/backlog_kit.svg)](https://gemnasium.com/emsk/backlog_kit)
[![Inline docs](http://inch-ci.org/github/emsk/backlog_kit.svg?branch=master)](http://inch-ci.org/github/emsk/backlog_kit)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
Ruby wrapper for the Nulab's Backlog API.
@@ -78,22 +78,23 @@
api_key: nil, # api_key should be nil
access_token: 'abcdefghij1234567890abcdefghij1234567890abcdefghij1234567890abcd'
)
```
-## ENV
+## BacklogKit::Client Config
-| ENV Variable | Description |
-| :----------- | :---------- |
-| `BACKLOG_SPACE_ID` | Your Backlog SPACE ID. |
-| `BACKLOG_TOP_LEVEL_DOMAIN` | Your Backlog TOP LEVEL DOMAIN. |
-| `BACKLOG_API_KEY` | Your Backlog API KEY. |
-| `BACKLOG_OAUTH_CLIENT_ID` | CLIENT ID of your Backlog application. |
-| `BACKLOG_OAUTH_CLIENT_SECRET` | CLIENT SECRET of your Backlog application. |
-| `BACKLOG_OAUTH_REFRESH_TOKEN` | REFRESH TOKEN obtained from the Backlog token endpoint. |
+| Variable | ENV Variable | Description | Default |
+| :------- | :----------- | :---------- | :------ |
+| `space_id` | `BACKLOG_SPACE_ID` | Your Backlog SPACE ID. ||
+| `second_level_domain` | `BACKLOG_SECOND_LEVEL_DOMAIN` | Your Backlog SECOND LEVEL DOMAIN. | `backlog` |
+| `top_level_domain` | `BACKLOG_TOP_LEVEL_DOMAIN` | Your Backlog TOP LEVEL DOMAIN. | `com` |
+| `api_key` | `BACKLOG_API_KEY` | Your Backlog API KEY. ||
+| `client_id` | `BACKLOG_OAUTH_CLIENT_ID` | CLIENT ID of your Backlog application. ||
+| `client_secret` | `BACKLOG_OAUTH_CLIENT_SECRET` | CLIENT SECRET of your Backlog application. ||
+| `refresh_token` | `BACKLOG_OAUTH_REFRESH_TOKEN` | REFRESH TOKEN obtained from the token endpoint. ||
-You can create instance more easily.
+If you set ENV variables, you can create an instance more simply.
```ruby
client = BacklogKit::Client.new
```
@@ -108,35 +109,10 @@
* Ruby 2.0.0
* Ruby 2.1
* Ruby 2.2
* Ruby 2.3
* Ruby 2.4
-
-## Development
-
-### Dependencies
-
-##### Production
-
-* [activesupport](https://github.com/rails/rails/tree/master/activesupport)
-* [faraday](https://github.com/lostisland/faraday)
-* [faraday_middleware](https://github.com/lostisland/faraday_middleware)
-
-##### Development
-
-* [bundler](https://github.com/bundler/bundler)
-* [coveralls](https://github.com/lemurheavy/coveralls-ruby)
-* [multi_json](https://github.com/intridea/multi_json)
-* [rake](https://github.com/ruby/rake)
-* [redcarpet](https://github.com/vmg/redcarpet)
-* [rspec](https://github.com/rspec/rspec)
-* [rubocop](https://github.com/bbatsov/rubocop)
-* [simplecov](https://github.com/colszowka/simplecov)
-* [vcr](https://github.com/vcr/vcr)
-* [webmock](https://github.com/bblimke/webmock)
-* [yard](https://github.com/lsegal/yard)
-
-See [`backlog_kit.gemspec`](backlog_kit.gemspec).
+* Ruby 2.5
## Contributing
1. Fork it ( https://github.com/emsk/backlog_kit/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)