README.md in underway-1.0.1 vs README.md in underway-1.1.0
- old
+ new
@@ -14,10 +14,16 @@
the included Sinatra routes, which allow you to quickly get access to a JWT or
access token for your App and its installations. Starting with a Sinatra
application is a fast way to build a GitHub App prototype and explore how
GitHub Apps work with the GitHub REST API.
+## Changelog
+
+This project adheres to [Semantic Versioning](http://semver.org). All notable
+changes are documented in the
+[CHANGELOG](https://github.com/jamesmartin/underway/blob/master/CHANGELOG.md).
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -88,20 +94,20 @@
```
You can get an access token for a given installation of your App:
```ruby
-installations = Underway::Api.invoke("/app/installations")
+installations = Underway::Api.invoke("app/installations")
access_token = Underway::Api.installation_token(id: installations.first.id)
```
Access tokens are cached, to save API calls. When an access token has expired a
new one will be generated and cached.
To get a list of repositories to which an installation of your App has access,
try this:
```ruby
-installations = Underway::Api.invoke("/app/installations")
+installations = Underway::Api.invoke("app/installations")
access_token = Underway::Api.installation_token(id: installations.first.id)
-repositories = Underway::Api.invoke("/installation/repositories", headers: { authorization: "token #{access_token}" })
+repositories = Underway::Api.invoke("installation/repositories", headers: { authorization: "token #{access_token}" })
```