Permalink
Browse files

Readme

  • Loading branch information...
1 parent c08404a commit 39feb5e298b4e4f7c175c266a3e763825d2478d9 @lautis lautis committed Oct 7, 2011
Showing with 22 additions and 0 deletions.
  1. +22 −0 Readme.md
View
@@ -0,0 +1,22 @@
+# node-flowdock
+
+Flowdock client/API for node.js. Listen to messages from Flowdock in real-time and post new messages.
+
+## Installation
+
+ npm install flowdock
+
+## Usage
+
+ var flowdock = require('flowdock');
+ var session = new flowdock.Session(username, password);
+
+ // Listening messages
+ session.subscribe(subdomain, flow);
+ session.on("message", function(message) {
+ console.log(message);
+ });
+
+## Development
+
+You'll need ```coffee-script``` for development. Code can be compiled with command ```cake build```.

0 comments on commit 39feb5e

Please sign in to comment.