Updated READMEs to use Markdown format.

README.md

@@ -1,68 +1,69 @@
-== APIClient
+# APIClient
 
-Homepage::  google-api-ruby-client[http://code.google.com/p/google-api-ruby-client/]
+<dl>
-Authors::   Bob Aman (mailto:bobaman@google.com), Matt Pokrzywa (mailto:mattpok@google.com)
+  <dt>Homepage</dt><dd><a href="http://code.google.com/p/google-api-ruby-client">http://code.google.com/p/google-api-ruby-client</a></dd>
-Copyright:: Copyright 2010 Google Inc.
+  <dt>Author</dt><dd><a href="mailto:bobaman@google.com">Bob Aman</a></dd>
-License::   Apache 2.0
+  <dt>Copyright</dt><dd>Copyright © 2011 Google, Inc.</dd>
+  <dt>License</dt><dd>Apache 2.0</dd>
+</dl>
 
-== Description
+# Description
 
 The Google API Ruby Client makes it trivial to discover and access supported
 APIs.
 
-== Example Usage
+# Example Usage
 
-  # Initialize the client
+    # Initialize the client
-  require 'google/api_client'
+    require 'google/api_client'
-  require 'signet/oauth_1/client'
+    require 'signet/oauth_1/client'
-  client = Google::APIClient.new(
+    client = Google::APIClient.new(
-    :service => 'buzz',
+      :service => 'buzz',
-    # Buzz has API-specific endpoints
+      # Buzz has API-specific endpoints
-    :authorization => Signet::OAuth1::Client.new(
+      :authorization => Signet::OAuth1::Client.new(
-      :temporary_credential_uri =>
+        :temporary_credential_uri =>
-        'https://www.google.com/accounts/OAuthGetRequestToken',
+          'https://www.google.com/accounts/OAuthGetRequestToken',
-      :authorization_uri =>
+        :authorization_uri =>
-        'https://www.google.com/buzz/api/auth/OAuthAuthorizeToken',
+          'https://www.google.com/buzz/api/auth/OAuthAuthorizeToken',
-      :token_credential_uri =>
+        :token_credential_uri =>
-        'https://www.google.com/accounts/OAuthGetAccessToken',
+          'https://www.google.com/accounts/OAuthGetAccessToken',
-      :client_credential_key => 'anonymous',
+        :client_credential_key => 'anonymous',
-      :client_credential_secret => 'anonymous'
+        :client_credential_secret => 'anonymous'
+      )
     )
-  )
+    client.authorization.fetch_temporary_credential!(
-  client.authorization.fetch_temporary_credential!(
+      :additional_parameters => {
-    :additional_parameters => {
+        'scope' => 'https://www.googleapis.com/auth/buzz'
-      'scope' => 'https://www.googleapis.com/auth/buzz'
+      }
-    }
+    )
-  )
+    redirect_uri = client.authorization.authorization_uri(
-  redirect_uri = client.authorization.authorization_uri(
+      :additional_parameters => {
-    :additional_parameters => {
+        'domain' => client.authorization.client_credential_key,
-      'domain' => client.authorization.client_credential_key,
+        'scope' => 'https://www.googleapis.com/auth/buzz'
-      'scope' => 'https://www.googleapis.com/auth/buzz'
+      }
-    }
+    )
-  )
+    # Redirect user here
-  # Redirect user here
+    client.authorization.fetch_token_credential!(:verifier => '12345')
-  client.authorization.fetch_token_credential!(:verifier => '12345')
     
-  # Discover available methods
+    # Discover available methods
-  method_names = client.discovered_api('buzz').to_h.keys
+    method_names = client.discovered_api('buzz').to_h.keys
     
-  # Make an API call
+    # Make an API call
-  response = client.execute(
+    response = client.execute(
-    'chili.activities.list',
+      'chili.activities.list',
-    {'scope' => '@self', 'userId' => '@me', 'alt' => 'json'}
+      {'scope' => '@self', 'userId' => '@me', 'alt' => 'json'}
-  )
+    )
-  status, headers, body = response
+    status, headers, body = response
 
-== Install
+# Install
 
-Be sure both http://gems.github.com/ and http://rubygems.org/ are in your gem
+Be sure `http://rubygems.org/` is in your gem sources.
-sources.
 
 For normal client usage, this is sufficient:
 
-sudo gem install google-api-client
+    $ sudo gem install google-api-client
 
 The command line interface, the example applications, and the test suite
 require additional dependencies. These may be obtained with:
 
-sudo gem install google-api-client --development --force --no-rdoc --no-ri
+    $ sudo gem install google-api-client --development --force --no-rdoc --no-ri

examples/prediction/README.md

@@ -1,5 +1,5 @@
-APIs Console Project Setup:
+APIs Console Project Setup
-------------
+--------------------------
 If you have not yet, you must set your APIs Console project to enable Prediction
 API and Google Storage. Go to APIs Console https://code.google.com/apis/console/
 and select the project you want to use. Next, go to Services, and enable both
@@ -7,7 +7,7 @@ Prediction API and Google Storage. You may also need to enable Billing (Billing)
 in the left menu.
 
 
-Data Setup:
+Data Setup
 ----------
 Before you can run the prediction sample prediction.rb, you must load some csv
 formatted data into Google Storage. 
@@ -15,7 +15,7 @@ formatted data into Google Storage.
 1 - You must first create the bucket you want to use. This can be done 
 with the gsutil function or via the web UI (Storage Access) in the Google 
 APIs Console. i.e. 
-# gsutil mb gs://BUCKET
+`$ gsutil mb gs://BUCKET`
 
 OR
 
@@ -25,12 +25,12 @@ and create your bucket there.
 2 - We now load the data you want to use to Google Storage. We have supplied a
 basic language identification dataset in the sample for testing.
 
-# chmod 744 setup.sh
+`$ chmod 744 setup.sh`
-# ./setup.sh BUCKET/OBJECT
+`$ ./setup.sh BUCKET/OBJECT`
 Note you need gsutil in your path for this to work.
 
 If you have your own dataset, you can do this manually as well.
-gsutil cp your_dataset.csv gs://BUCKET/your_dataset.csv
+`$ gsutil cp your_dataset.csv gs://BUCKET/your_dataset.csv`
 
 
 In the script, you must then modify the datafile string. This must correspond with the
@@ -38,7 +38,7 @@ bucket/object of your dataset (if you are using your own dataset). We have
 provided a setup.sh which will upload some basic sample data. The section is
 near the bottom of the script, under 'FILL IN DATAFILE'
 
-API setup:
+API Setup
 ---------
 We need to allow the application to use your API access. Go to APIs Console
 https://code.google.com/apis/console, and select the project you want, go to API
@@ -51,8 +51,8 @@ API. You can also set it up so the user can grant access.
 
 First, run the google-api script to generate access and refresh tokens. Ex.
 
-# cd google-api-ruby-client
+`$ cd google-api-ruby-client`
-# ruby bin/google-api oauth-2-login --scope=https://www.googleapis.com/auth/prediction --client-id=NUMBER.apps.googleusercontent.com --client-secret=CLIENT_SECRET
+`$ ruby bin/google-api oauth-2-login --scope=https://www.googleapis.com/auth/prediction --client-id=NUMBER.apps.googleusercontent.com --client-secret=CLIENT_SECRET`
 
 Fill in your client-id and client-secret from the API Access page. You will
 probably have to set a redirect URI in your client ID
@@ -70,8 +70,8 @@ you are loading it as a yaml, ensure you rename/move the file, as the
 move the .google-api.yaml file to the sample directory.
 
 
-Usage :
+Usage
--------
+-----
 At this, point, you should have 
  - Enabled your APIs Console account
  - Created a storage bucket, if required
@@ -81,19 +81,14 @@ At this, point, you should have
    loading the generated .yaml file
  
 We can now run the service! 
-# ruby prediction.rb
+`$ ruby prediction.rb`
 
-This should start a service on http://localhost:4567. When you hit the service,
+This should start a service on `http://localhost:4567`. When you hit the service,
 your ruby logs should show the Prediction API calls, and print the prediction
 output in the debug. 
 
-
-
 This sample currently does not cover some newer features of Prediction API such
 as streaming training, hosted models or class weights. If there are any
 questions or suggestions to improve the script please email us at
 prediction-api-discuss@googlegroups.com.
 
-
-
-