updated README to include note about api_url not being required and h…

…aving a default value
jrbeilke · Nov 7, 2016 · 2258417 · 2258417
1 parent 997644b
commit 2258417
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -51,8 +51,11 @@ You can pass configuration options as a block to `Teamsupport::REST::Client.new`
     client = Teamsupport::REST::Client.new do |config|
       config.api_key    = "TEAMSUPPORT_ORGANIZATION_ID"
       config.api_secret = "TEAMSUPPORT_API_TOKEN"
+      config.api_url = "TEAMSUPPORT_API_URL"
     end
 
+The API url is not required and will default to `https://app.teamsupport.com` if not defined in config.
+
 ## Usage Examples
 After configuring a `client`, you can do the following things.