some documentation tweaks and add the generated docs

aaudis · Dec 5, 2011 · c0d2ba7 · c0d2ba7
1 parent 554cbb1
commit c0d2ba7
Show file tree

Hide file tree

Showing 22 changed files with 3,141 additions and 8 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,5 @@
 Copyright (c) 2011 TJ Holowaychuk
-Copyright (c) 2010 Justin Tulloss
+Copyright (c) 2010, 2011 Justin Tulloss
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 
 # node-zeromq
 
-  ØMQ bindings for node.js, a fork of [zeromq.node](https://github.com/JustinTulloss/zeromq.node).
+  ØMQ bindings for node.js
 
 ## Installation
 
-    $ npm install zeromq
+    $ npm install zmq
 
 ## Example
 
@@ -15,7 +15,7 @@ producer.js:
 var zmq = require('zeromq')
   , sock = zmq.socket('push');
 
-sock.bind('tcp://127.0.0.1:3000');
+sock.bindSync('tcp://127.0.0.1:3000');
 console.log('Producer bound to port 3000');
 
 setInterval(function(){
@@ -42,14 +42,14 @@ sock.on('message', function(msg){
 ## Running tests
 
   Install dev deps:
-  
+
      $ npm install
 
   Build:
 
      $ make
 
   Test:
-  
+
      $ make test