Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Sync README file with the edoc overview

  • Loading branch information...
commit 578b6fc40fcc1cf4d1bd57dfb1e1a0b3396983cf 1 parent 4c43403
@evax evax authored
Showing with 12 additions and 1 deletion.
  1. +12 −1 README.md
View
13 README.md
@@ -2,7 +2,7 @@ erlzmq2
====
NIF based Erlang bindings for the ZeroMQ messaging library.
-Copyright (c) 2011 Yurii Rashkovskii and Evax Sofware
+Copyright (c) 2011 Yurii Rashkovskii and Evax Software
Overview
========
@@ -44,4 +44,15 @@ Run the test suite
$ make test
+Please note that to behave properly on your system ZeroMQ might require [some tuning](http://www.zeromq.org/docs:tuning-zeromq).
+
+Architecture
+============
+
+The bindings use Erlang's [NIF (native implemented functions)](http://www.erlang.org/doc/man/erl_nif.html) interface to achieve the best performance. One extra OS thread and one pair of inproc sockets by context are used to simulate blocking recv calls without affecting the Erlang virtual machine's responsiveness.
+
+License
+=======
+
+The project is released under the MIT license.
Please sign in to comment.
Something went wrong with that request. Please try again.