1- # zmq-prebuilt
1+ # zeromq
22
3- [ ![ codecov] ( https://codecov.io/gh/nteract/zmq-prebuilt /branch/master/graph/badge.svg )] ( https://codecov.io/gh/nteract/zmq-prebuilt )
3+ [ ![ codecov] ( https://codecov.io/gh/zeromq/zeromq.js /branch/master/graph/badge.svg )] ( https://codecov.io/gh/zeromq/zeromq.js )
44[ ![ ] ( https://img.shields.io/badge/version-latest-blue.svg )] ( https://github.com/nteract/zmq-prebuilt )
5- [ ![ Build Status] ( https://travis-ci.org/nteract/zmq-prebuilt. svg?branch=master )] ( https://travis-ci.org/nteract/zmq-prebuilt )
6- [ ![ Build status] ( https://ci.appveyor.com/api/projects/status/6u7saauir2msxpou?svg=true )] ( https://ci.appveyor.com/project/nteract/zmq-prebuilt )
5+ [ ![ Build Status] ( https://travis-ci.org/zeromq/zeromq.js. svg?branch=master )] ( https://travis-ci.org/zeromq/zeromq.js )
6+ [ ![ Build status] ( https://ci.appveyor.com/api/projects/status/6u7saauir2msxpou?svg=true )] ( https://ci.appveyor.com/project/zeromq/zeromq.js )
77[ ![ ] ( https://img.shields.io/badge/version-stable-blue.svg )] ( https://github.com/nteract/zmq-prebuilt/releases/tag/v1.4.0 )
88[ ![ Build Status] ( https://travis-ci.org/nteract/zmq-prebuilt-testing.svg?branch=master )] ( https://travis-ci.org/nteract/zmq-prebuilt-testing )
99[ ![ Build status] ( https://ci.appveyor.com/api/projects/status/ox85p208tsxw6vt1?svg=true )] ( https://ci.appveyor.com/project/nteract/zmq-prebuilt-testing )
1010
1111[ ** Users** ] ( #installation--users ) | [ ** Contributors and Development** ] ( #installation---contributors-and-development ) | [ ** Maintainers** ] ( #for-maintainers-creating-a-release )
1212
13- ** zmq-prebuilt ** : Your ready to use, prebuilt [ ØMQ] ( http://www.zeromq.org/ )
13+ ** zeromq ** : Your ready to use, prebuilt [ ØMQ] ( http://www.zeromq.org/ )
1414bindings for [ Node.js] ( https://nodejs.org/en/ ) .
1515
1616ØMQ provides handy functionality when working with sockets. Yet,
1717installing dependencies on your operating system or building ØMQ from
1818source can lead to developer frustration.
1919
20- ** zmq-prebuilt ** simplifies creating communications for a Node.js
20+ ** zeromq ** simplifies creating communications for a Node.js
2121application by providing well-tested, ready to use ØMQ bindings.
22- zmq-prebuilt supports all major operating systems, including:
22+ zeromq supports all major operating systems, including:
2323
2424* OS X/Darwin 64-bit
2525* Linux 64-bit
2626* Windows (64-bit and 32-bit)
2727
28- Use ** zmq-prebuilt ** and take advantage of the * elegant simplicity of binaries* .
28+ Use ** zeromq ** and take advantage of the * elegant simplicity of binaries* .
2929
3030
31- ----
32-
3331## Installation - Users
3432
35- * Prerequisites*
36-
3733We rely on [ ` prebuild ` ] ( https://github.com/mafintosh/prebuild ) .
3834
39- Install ` zmq-prebuilt ` with the following:
35+ Install ` zeromq ` with the following:
4036
4137``` bash
42- npm install zmq-prebuilt
38+ npm install zeromq
4339```
4440
4541Now, prepare to be amazed by the wonders of binaries.
4642
47- ## Usage
48-
49- Replace ` require('zmq') ` in your code base with ` require('zmq-prebuilt') ` . That's it.
50- The wonder of binaries begins.
51-
52- ----
5343
5444## Installation - Contributors and Development
5545
56- To set up ` zmq-prebuilt ` for development, fork this repository and
46+ To set up ` zeromq ` for development, fork this repository and
5747clone your fork to your system.
5848
5949** Prerequisites for Linux**
@@ -84,7 +74,7 @@ Use your distribution's package manager to install.
8474
8575** Installation**
8676
87- Install a development version of ` zmq-prebuilt ` with the following:
77+ Install a development version of ` zeromq ` with the following:
8878
8979``` bash
9080npm install
@@ -109,7 +99,7 @@ node examples/subber.js
10999```
110100
111101
112- ## Examples using zmq-prebuilt
102+ ## Examples using zeromq
113103
114104### Push/Pull
115105
@@ -120,7 +110,7 @@ socket and how a worker pulls information from the socket.
120110
121111``` js
122112// producer.js
123- var zmq = require (' zmq-prebuilt ' )
113+ var zmq = require (' zeromq ' )
124114 , sock = zmq .socket (' push' );
125115
126116sock .bindSync (' tcp://127.0.0.1:3000' );
@@ -136,7 +126,7 @@ setInterval(function(){
136126
137127``` js
138128// worker.js
139- var zmq = require (' zmq-prebuilt ' )
129+ var zmq = require (' zeromq ' )
140130 , sock = zmq .socket (' pull' );
141131
142132sock .connect (' tcp://127.0.0.1:3000' );
@@ -149,14 +139,14 @@ sock.on('message', function(msg){
149139
150140### Pub/Sub
151141
152- This example demonstrates using ` zmq-prebuilt ` in a classic Pub/Sub,
142+ This example demonstrates using ` zeromq ` in a classic Pub/Sub,
153143Publisher/Subscriber, application.
154144
155145** Publisher: pubber.js**
156146
157147``` js
158148// pubber.js
159- var zmq = require (' zmq-prebuilt ' )
149+ var zmq = require (' zeromq ' )
160150 , sock = zmq .socket (' pub' );
161151
162152sock .bindSync (' tcp://127.0.0.1:3000' );
@@ -172,7 +162,7 @@ setInterval(function(){
172162
173163``` js
174164// subber.js
175- var zmq = require (' zmq-prebuilt ' )
165+ var zmq = require (' zeromq ' )
176166 , sock = zmq .socket (' sub' );
177167
178168sock .connect (' tcp://127.0.0.1:3000' );
@@ -184,7 +174,6 @@ sock.on('message', function(topic, message) {
184174});
185175```
186176
187- ----
188177
189178## For maintainers: Creating a release
190179
@@ -203,13 +192,3 @@ npm publish
203192
204193To check if the binaries are packaged correctly, you can push a commit to
205194[ ` nteract/zmq-prebuilt-testing ` ] ( https://github.com/nteract/zmq-prebuilt-testing ) .
206-
207- ## Learn more about nteract
208-
209- - Visit our website http://nteract.io/ .
210- - See our organization on GitHub https://github.com/nteract
211- - Join us on [ Slack] ( http://slack.nteract.in/ ) if you need help or have
212- questions. If you have trouble creating an account, either
213- email rgbkrk@gmail.com or post an issue on GitHub.
214-
215- <img src =" https://cloud.githubusercontent.com/assets/836375/15271096/98e4c102-19fe-11e6-999a-a74ffe6e2000.gif " alt =" nteract animated logo " height =" 80px " />
0 commit comments