From 3d3dcfe11511b44a6f169a503108450854378ee6 Mon Sep 17 00:00:00 2001
From: Christian Fobel <christian@fobel.net>
Date: Fri, 15 Aug 2014 14:36:00 -0400
Subject: [PATCH] Add README

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d0e023
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# ZeroMQ service MicroDrop plugin #
+
+This project implements a [MicroDrop][1] [plugin][2] to interface with a
+[ZeroMQ][3] service.
+
+The basic idea is to have a service exposed through a ZeroMQ interface,
+responding on a `zmq.REP` socket to the following two messages:
+
+ - `start` -> `started`
+ - `notify_completion` -> `completed`
+
+This provides a basic inter-process method for starting a service,
+followed by a notification upon completion.  The plugin provides a
+timeout option for each step in the DMF protocol to limit the amount of
+time spent waiting for a service to complete.
+
+__NB__ As of this commit, the MicroDrop app seems to freeze in the case
+where the service times out, after the error message indicating the
+protocol has failed is displayed.  This is likely due to threading
+issues, which will be resolved after the plug-ins are ported to run in
+separate processes.
+
+[1]: http://microfluidics.utoronto.ca/microdrop
+[2]: https://software.sandia.gov/trac/pyutilib/export/1831/pyutilib.component.doc/trunk/doc/plugin/pca.pdf
+[3]: http://zeromq.org
-- 
GitLab