Merge pull request #1 from taotetek/master

Problem: there is no documentation
zeromq · Sep 6, 2014 · bc190df · bc190df
2 parents c77a3ce + 3b2a027
commit bc190df
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,4 @@
+Contributors
+============
+
+Brian Knox
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Contributing to goczmq
+
+The contributors are listed in AUTHORS (add yourself). This project uses the MPL v2 license, see LICENSE.
+
+* goczmq uses the [C4.1 (Collective Code Construction Contract)](http://rfc.zeromq.org/spec:22) process for contributions. Please read this if you are unfamiliar with it.
+
+* goczmq uses [golint](https://github.com/golang/lint) for style enforcement.
+
+Remember: one problem, one commit, and your code should look like all the other code in CZMQ. Thanks!
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+A go interface to [CZMQ](http://czmq.zeromq.org)
+
+This requires CZMQ head, and is targetted to be compatible with the next stable release of CZMQ.
+
+Development is currently using CZMQ head compiled against ZeroMQ 4.0.4 Stable.
+
+## Install
+
+  go get github.com/zeromq/goczmq
+
+## Currently Working
+
+* Bare bones zsock functionality.  Sockets can be created and destroyed, and messages can be sent.
+
+## Next Objectives
+
+* Finish support of zsock api, working with sending go byte arrays.
+
+## See Also
+
+Peter Kleiweg's excellent zmq4 library for libzmq: http://github.com/pebbe/zmq4