Adds simple integration with googleauth

[arvados.git] / README.md

diff --git a/README.md b/README.md
index 1c71e2d096ea5d82963e14aae2f7a15512900e13..afb6bc5316fbc450cee6d462d952db6c85622c1d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,6 +15,10 @@
 The Google API Ruby Client makes it trivial to discover and access supported
 APIs.
 
+## Alpha
+
+This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary.
+
 ## Install
 
 Be sure `https://rubygems.org/` is in your gem sources.
@@ -83,8 +87,13 @@ drive = client.discovered_api('drive', 'v2')
 Locally cached discovery documents may be used as well. To load an API from a local file:
 
 ```ruby
+# Output discovery document to JSON
+File.open('my-api.json', 'w') do |f| f.puts MultiJson.dump(client.discovery_document('myapi', 'v1')) end
+
+# Read discovery document and load API
 doc = File.read('my-api.json')
-my_api = client.register_discovery_document('myapi', 'v1', doc)
+client.register_discovery_document('myapi', 'v1', doc)
+my_api = client.discovered_api('myapi', 'v1')
 ```
 
 ### Authorization
@@ -128,7 +137,7 @@ Example:
 
 ```ruby
 client = Google::APIClient.new
-urlshortener = client.discovered_api('urlshortner')
+urlshortener = client.discovered_api('urlshortener')
 
 batch = Google::APIClient::BatchRequest.new do |result|
     puts result.data