Permalink
Browse files

Added initial README.md

  • Loading branch information...
1 parent 2fbe755 commit e5fb493f808f39015337c7cb41d718568e772dbf @yrashk yrashk committed Mar 4, 2011
Showing with 39 additions and 0 deletions.
  1. +39 −0 README.md
View
@@ -0,0 +1,39 @@
+ezmq
+====
+NIF based Erlang bindings for the ZeroMQ messaging library.
+
+Copyright (c) 2011 Yurii Rashkovskii and Evax Sofware
+
+Overview
+========
+
+The ezmq application provides high-performance NIF based Erlang bindings
+for the ZeroMQ messaging library.
+
+Downloading
+===========
+
+The ezmq source code can be found on [GitHub](https://github.com/yrashk/ezmq)
+
+ $ git clone http://github.com/yrashk/ezmq.git
+
+It is also available on [Agner](http://erlagner.org/):
+
+ $ agner build ezmq
+
+Building
+========
+
+Build the code
+
+ $ make
+
+Build the docs
+
+ $ make docs
+
+Run the test suite
+
+ $ make test
+
+

0 comments on commit e5fb493

Please sign in to comment.