Permalink
Browse files

Add README

  • Loading branch information...
1 parent 1d711fd commit 93c74ce11d648ba545ecaefd3fc1c2788c4f9e64 Evan Shaw committed Nov 30, 2011
Showing with 36 additions and 0 deletions.
  1. +36 −0 README.md
View
@@ -0,0 +1,36 @@
+IronMQ Java Client
+----------------
+
+Getting Started
+===============
+
+Build the JAR with [Apache Buildr](http://buildr.apache.org).
+
+ buildr package
+
+The .jar file will appear under the target directory.
+
+The API is documented [here](http://iron-io.github.com/ironmq_java/).
+
+The Basics
+==========
+**Initialize** a client and get a queue object:
+
+ Client client = new Client("my project", "my token");
+ Queue queue := client.queue("my_queue");
+
+**Push** a message on the queue:
+
+ queue.Push("Hello, world!");
+
+**Pop** a message off the queue:
+
+ Message msg = queue.get();
+
+When you pop/get a message from the queue, it will *not* be deleted. It will
+eventually go back onto the queue after a timeout if you don't delete it. (The
+default timeout is 10 minutes.)
+
+**Delete** a message from the queue:
+
+ queue.deleteMessage(msg);

0 comments on commit 93c74ce

Please sign in to comment.