Permalink
Browse files

Updated the readme slightly.

  • Loading branch information...
bennadel committed Mar 16, 2012
1 parent 8f1d510 commit 8912146550d1c6bf98eaedfe71aa28c1c42ebf75
Showing with 23 additions and 2 deletions.
  1. +23 −2 README.md
View
@@ -1,3 +1,24 @@
-ColdFusion 10 WebSocket AMD Compliant(ish) Module
+# ColdFusion 10 WebSocket AMD Compliant(ish) Module
-Working...
+## Constructor
+
+```ColdFusionWebSocket( coldfusionAppName [, channel [, headers]] )```
+
+The first argument, coldfusionAppName, is the name of your server-side ColdFusion application as determined by the "this.name" value you define in your Application.cfc. If you this is not an easy accessible value, you can always access it using the getApplicationMetaData() method.
+
+## Public Methods
+
+* authenticate( username, password ) :: Promise
+* closeConnection()
+* getClientID() :: Int
+* getSubscriberCount( channel ) :: Promise
+* getSubscriptions() :: Promise
+* isConnectionOpen() :: Boolean
+* off( eventType, callback )
+* on( eventType [, channel], callback [, context] )
+* openConnection()
+* parse( json ) :: Any
+* publish( channel, data [, headers] )
+* stringify( value ) :: JSON
+* subscribe( channel [, headers] )
+* unsubscribe( channel )

0 comments on commit 8912146

Please sign in to comment.