Rewriting and Markdownifying README.

minimal · Dec 1, 2009 · e3910df · e3910df
1 parent 3384673
commit e3910df
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 17 deletions.
diff --git a/README b/README
diff --git a/README.markdown b/README.markdown
@@ -0,0 +1,27 @@
+# Clojure client for RabbitMQ (AMQP) #
+
+## Installation ##
+
+Get the latest java rabbitmq-client from <http://www.rabbitmq.com/java-client.html>.
+
+You can use the `fetchdeps.sh` script to do this; the RabbitMQ 1.7.0 Java
+client will be fetched and unpacked into `lib/`, where `build.xml` expects it.
+
+Build `clojure-rabbitmq.jar` by invoking `ant` with the appropriate
+arguments, e.g.:
+
+    ant -Dclojure.jar=/opt/clojure/clojure.jar -Dcontrib.jar=/opt/clojure-contrib/clojure-contrib.jar
+
+
+## Usage and API ##
+
+Ensure that `clojure-rabbitmq.jar` and the RabbitMQ jars are in your classpath.
+
+`.clojure` is set up appropriately for the common `clj` script.
+
+Then:
+
+   (use 'com.github.icylisper.rabbitmq)
+
+
+See `example/publisher.clj` and `example/consumer.clj` for usage.