Skip to content

Commit d422a08

Browse files
committedMar 16, 2013
README cleanup and adding a screenshot.
1 parent b893838 commit d422a08

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed
 

‎README.md

+26-9
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,56 @@
11
# Google Drive Realtime API Playground
22

3+
![Google Drive Realtime API Playground Screenshot](https://github.com/googledrive/realtime-playground/raw/master/screenshot.png)
4+
35
## Overview
46

5-
**Google Drive Realtime API Playground**, is a web app for web developer that lets you try out the features of the [Google Drive Realtime API](https://developers.google.com/drive/realtime).
7+
**Google Drive Realtime API Playground**, is a web app that helps you to try out the features of the [Google Drive Realtime API](https://developers.google.com/drive/realtime).
68

79
The Playground will take you through the steps required to have the Realtime API working on your application and can be used as a reference implementation of a Google Drive Realtime API application.
810

911
You can try out the Google Drive Realtime API Playground on its [live instance](https://realtimeplayground.appspot.com).
1012

1113
## Installation and Configuration
1214

13-
The project can be run out of any static web server though we provide a configuration file to host it on App Engine.
15+
The project can run on any static web server, but we also provide required configuration and boilerplate files to host it on App Engine.
1416

1517
If you wish to host it in your own App Engine instance make sure you set the name of your App Engine application in `/app.yaml`. To create an App Engine instance follow the instructions on [appengine.google.com](https://appengine.google.com).
1618

1719
### Create a Google APIs project and Activate the Drive API
1820

19-
First, you need to activate the Drive API for your app. You can do this in your app's API project in the Google APIs Console.
21+
First, you need to activate the Drive API for your app. You can do it by configuring your API project in the Google APIs Console.
2022

2123
- Create an API project in the [Google APIs Console](https://developers.google.com/console).
22-
- Select the Services tab in your API project, and enable the Drive API and the Drive SDK.
23-
- Select the API Access tab in your API project, and click Create an OAuth 2.0 client ID.
24-
- In the Branding Information section, provide a name for your application (e.g. "Google Drive Realtime API Playground"), and click Next. Providing a product logo is optional.
24+
- Select the "Services" tab and enable the Drive API.
25+
- Select the "API Access" tab in your API project, and click "Create an OAuth 2.0 client ID".
26+
- In the Branding Information section, provide a name for your application (e.g. "CollabCube 3D"), and click Next. Providing a product logo is optional.
2527
- In the Client ID Settings section, do the following:
2628
- Select Web application for the Application type
2729
- Click the more options link next to the heading, Your site or hostname.
2830
- List your hostname in the Authorized Redirect URIs and JavaScript Origins fields.
2931
- Click Create Client ID.
3032
- In the **API Access** page, locate the section **Client ID for Web applications** and note the **Client ID** value.
3133
- List your hostname in JavaScript origins in the Client ID settings.
32-
- Go to the **Drive SDK** page and copy the **App ID**
33-
34+
- Go to the **Drive SDK** page and copy the **App ID**.
3435

3536
### Setup your App information in the code
3637

3738
You should now have your **Client ID** and your **App ID**. In `/js/rtpg.js` change the `APP_ID` and the `CLIENT_ID` constants at the top of the file.
3839

39-
### Deploy, run that's it!
40+
### Deploy, run that's it!
41+
42+
## Contributing
43+
44+
Before creating a pull request, please fill out either the individual or
45+
corporate Contributor License Agreement.
46+
47+
* If you are an individual writing original source code and you're sure you
48+
own the intellectual property, then you'll need to sign an
49+
[individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
50+
* If you work for a company that wants to allow you to contribute your work
51+
to this client library, then you'll need to sign a
52+
[corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
53+
54+
Follow either of the two links above to access the appropriate CLA and
55+
instructions for how to sign and return it. Once we receive it, we'll add you
56+
to the official list of contributors and be able to accept your patches.

‎screenshot.png

157 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.