summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ddc47bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# ZeroMQ
+
+[![Build Status](https://travis-ci.org/zeromq/libzmq.png?branch=master)](https://travis-ci.org/zeromq/libzmq)
+
+## Welcome
+
+The 0MQ lightweight messaging kernel is a library which extends the
+standard socket interfaces with features traditionally provided by
+specialised messaging middleware products. 0MQ sockets provide an
+abstraction of asynchronous message queues, multiple messaging patterns,
+message filtering (subscriptions), seamless access to multiple transport
+protocols and more.
+
+## Stable Fork
+
+This repository is used for making stable releases. Please do not send
+pull requests here unless they are specifically and only for this fork.
+Rather, send them to libzmq/master. Issues with test cases may be back
+ported to this repository by its maintainers.
+
+## Building and installation
+
+See the INSTALL file included with the distribution.
+
+## Resources
+
+Extensive documentation is provided with the distribution. Refer to
+doc/zmq.html, or "man zmq" after you have installed 0MQ on your system.
+
+Website: http://www.zeromq.org/
+
+Development mailing list: zeromq-dev@lists.zeromq.org
+Announcements mailing list: zeromq-announce@lists.zeromq.org
+
+Git repository: http://github.com/zeromq/libzmq
+
+0MQ developers can also be found on the IRC channel #zeromq, on the
+Freenode network (irc.freenode.net).
+
+## Copying
+
+Free use of this software is granted under the terms of the GNU Lesser General
+Public License (LGPL). For details see the files `COPYING` and `COPYING.LESSER`
+included with the 0MQ distribution.