Permalink
Browse files

added file ext to README

  • Loading branch information...
1 parent f3a66c9 commit 6aa835094bb399f115f86ab9677a307c8ef1ce69 @scottbw committed Nov 28, 2010
Showing with 0 additions and 41 deletions.
  1. +0 −41 README
View
41 README
@@ -1,41 +0,0 @@
-# Wave-Node
-
-This is an implementation of the Google Wave Gadget API using Node.js, WebSockets, and a key/value store.
-
-It uses diff-match-patch to synchronize states across multiple instances: clients send patches to the server, which then propagages the patches to other clients which
-apply the patches to their local state model. So no matter how big the state model becomes, each update event is quite small.
-
-## Installation
-
-You need to install Node.js with SocketIO and Keys:
-
- $ npm install socketio
- $ npm install keys
- $ npm install redis
-
-## Client API
-
-Each page or widget wanting to use the service needs to import the following JavaScript files:
-
-diff_match_patch.js
-json2.js
-socket.io.js
-wave.js
-
-In addition you need to call the following methods in your own scripts after importing the wave.js library:
-
-wave.setSharedDataKey(key) : this is the "context identifier" for the pages/widgets that will share state.
-wave.setViewer(id, name, icon src) : this is the current user's information
-
-For example:
-
- wave.setSharedDataKey("SPACE1");
- wave.setViewer("mindyourownbusiness","alice","smileys/rabbit.png");
-
-When both have been set, your page/widget will handshake with the server.
-
-You can then use the Wave Gadget API as described at: http://code.google.com/apis/wave/extensions/gadgets/guide.html
-
-## Notes
-
-Note that private states are not supported yet, nor are getHost() or state.clear().

0 comments on commit 6aa8350

Please sign in to comment.