README.md in underway-1.1.0 vs README.md in underway-2.0.0

- old
+ new

@@ -25,11 +25,11 @@ ## Installation Add this line to your application's Gemfile: ```ruby -gem "underway", "~> 1.0" +gem "underway", "~> 1.1" ``` And then run: ``` @@ -71,15 +71,30 @@ Sinatra application, do something like this: ```ruby require "underway" -# This assumes that your configuration file and private key file is located in -# the same directory as the current ruby file. +Underway::Settings.configure do |config| + # Note: config.app_root is no longer supported as of version 2.0. Just pass + # the absolute or relative path to the configuration file. + config.config_filename = "./config.json" +end +``` +You can also configure Underway by individually setting its configuration +attributes: + +```ruby +require "underway" + Underway::Settings.configure do |config| - config.app_root = __FILE__ - config.config_filename = "config.json" + config.app_id = "some-app-id" + config.client_id = "some-client-id" + config.client_secret = "some-client-secret" + config.database_url = "/some/db/url" + config.github_api_host = "https://api.github.com" + config.webhook_secret = "some-webhook-secret" + config.private_key = "my-pem" end ``` ## Usage