README.md in underway-1.0.0 vs README.md in underway-1.0.1
- old
+ new
@@ -1,7 +1,9 @@
# Underway
+[](https://travis-ci.org/jamesmartin/underway)
+
Underway is a Ruby gem that helps developers quickly prototype [GitHub
Apps](https://developer.github.com/apps/).
Underway consists of some convenience wrappers for the GitHub REST API, with a
particular focus on generating credentials for accessing installation resources
@@ -43,12 +45,14 @@
- Your GitHub App's ID (an integer)
- A private key file (.pem)
- A webhook secret (optional)
-Make a copy of the [config.json.example]() file in a location readable by your
-application and edit the file to match your GitHub App's settings.
+Make a copy of the
+[config.json.example](https://github.com/jamesmartin/underway/blob/master/config.json.example)
+file in a location readable by your application and edit the file to match your
+GitHub App's settings.
At its core, Underway is just a Ruby library and can be used in virtually any
application. To get started quickly and test out your new GitHub App you might
want to use the included [Sinatra](http://sinatrarb.com) routes. A complete
[example Sinatra
@@ -68,6 +72,36 @@
Underway::Settings.configure do |config|
config.app_root = __FILE__
config.config_filename = "config.json"
end
+```
+
+## Usage
+
+The most useful part of Underway for interacting with GitHub Apps is found in
+the `Underway::Api` class.
+
+For example, right out of the box you can generate a JWT for your App:
+
+```ruby
+Underway::Api.generate_jwt
+```
+
+You can get an access token for a given installation of your App:
+
+```ruby
+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")
+access_token = Underway::Api.installation_token(id: installations.first.id)
+repositories = Underway::Api.invoke("/installation/repositories", headers: { authorization: "token #{access_token}" })
```