Permalink
Browse files

Add license and readme

  • Loading branch information...
1 parent 0812da9 commit f75332854094ad5779664a4839e7cb1c751dbf9c @mnutt committed Dec 3, 2010
Showing with 48 additions and 1 deletion.
  1. +20 −0 LICENSE
  2. +28 −1 README
View
20 LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael Nutt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
View
29 README
@@ -1,4 +1,31 @@
-Watches a redis pubsub channel and broadcasts to websockets.
+redis-pubsub-to-websockets
+--------------------------
+
+Watches a redis pubsub channel and broadcasts to websockets. (Socket.IO)
by Michael Nutt
michael@nuttnet.net
+
+
+Requirements
+============
+
+ * node.js >= 0.2.4
+ * npm
+
+
+Installation
+============
+
+ * npm bundle
+ * node app.js [redis_key]
+
+Notes
+=====
+
+To set up the Socket.IO client to connect to node, follow the guide here: http://socket.io.
+
+License
+=======
+
+MIT License. Copyright 2010 Michael Nutt. See LICENSE.

0 comments on commit f753328

Please sign in to comment.