Skip to content
Browse files

updated readme

  • Loading branch information...
1 parent b213aa3 commit 9f446e63e74217edcdcf7bacb13bc63d4b68d9fe @rodsimpson rodsimpson committed Feb 7, 2013
Showing with 19 additions and 4 deletions.
  1. +19 −4 readme.md
View
23 readme.md
@@ -3,15 +3,30 @@
#Overview
Messagee is a [Twitter](http://twitter.com) clone built on Usergrid, the open source solution that powers Apigee's App Services. In this simplistic example, we show how you can easily implement many of the features of [Twitter](http://twitter.com) by leveraging the Usergrid API.
-For a high-level overview that covers some of the basic concepts in this , please see this article:
-
-<http://apigee.com/about/api-best-practices/building-twitter-apigee-app-services>
-
#Demo
A working example of this app can be found on our gh-pages branch:
<http://apigee.github.com/usergrid-sample-html5-messagee>
+#Running the app
+To get started, download the code to your machine, unzip the file, and extract the files inside. Then, open this file in a text editor:
+
+ js/app.js
+
+And locate this code that starts on line 34:
+
+ var client = new Usergrid.Client({
+ orgName:'ApigeeOrg', //your orgname goes here (not case sensitive)
+ appName:'MessageeApp', //your appname goes here (not case sensitive)
+ logging: true, //optional - turn on logging, off by default
+ buildCurl: true //optional - turn on curl commands, off by default
+ });
+
+Change the orgName property to match the organization you created when you signed up for App services (usually your username), and then change the appName to match the name of the Application namespace you created in the Admin portal. By default, all new accounts come with a application namespace called "sandbox", and you can use this too.
+
+Once you have done this, simply open the index.html file in a browser window (avoid Internet Explorer as it has known issues) and you should be ready to go. Try creating an account and logging in.
+
+
#Open Source
This project is open source. Please feel free to use and modify as permitted by the license. Want to add something? Find a bug? We welcome pull requests.

0 comments on commit 9f446e6

Please sign in to comment.
Something went wrong with that request. Please try again.