From 0c88498697a3245c7f3f868861510abb592d1bbf Mon Sep 17 00:00:00 2001
From: Rick Harrison <r@rickharrison.me>
Date: Wed, 20 Jul 2016 14:21:24 -0700
Subject: [PATCH] Adds README.

---
 README.md    | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 package.json |  2 +-
 2 files changed, 71 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a560ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+# @meadow/sqs
+
+[![Build Status](https://circleci.com/gh/meadow/sqs.svg?style=shield)](https://circleci.com/gh/meadow/sqs)
+[![codecov.io](https://codecov.io/github/meadow/sqs/coverage.svg?branch=master&precision=2)](https://codecov.io/github/meadow/sqs?branch=master)
+[![npm](https://img.shields.io/npm/v/@meadow/sqs.svg)](https://www.npmjs.com/package/@meadow/sqs)
+
+Promise/JSON based client for Amazon SQS with automatic long-polling.
+
+- Requires node v6.x
+
+## Installation
+
+```js
+npm install @meadow/sqs --save
+```
+
+## Usage
+
+Create a client:
+
+```js
+const sqs = require('@meadow/sqs');
+
+const client = new sqs({
+  region: 'us-west-2',
+  accessKeyId: 'AKFOOBAR',
+  secretAccessKey: 'barbaz',
+  queue: 'https://sqs.us-west-2.amazonaws.com/foobar/barbaz'
+});
+```
+
+Send a message:
+
+```js
+client.sendMessage({
+  type: 'ACTION_TYPE',
+  payload: {
+    foo: 'bar'
+  }
+});
+```
+
+Long poll the queue for messages:
+
+```js
+client.pollQueue({ VisibilityTimeout: 600 }, function (message) {
+  console.log(message);
+
+  return new Promise(function (resolve) {
+    // Perform the work for this message
+
+    resolve();
+  });
+});
+```
+
+## API
+
+Everything is built around promises and JSON. Amazon SQS only supports message bodies as strings, but this client will transform that to and from JSON for you automatically. When polling the queue, `@meadow/sqs` expects that you return a promise. When that promise resolves, the message will automatically be deleted from the SQS queue.
+
+#### sendMessage(payload)
+
+- `payload` - A JSON object that will be persisted to the Amazon SQS queue.
+
+#### pollQueue (options, handler)
+
+Calling this method will long-poll the Amazon SQS queue waiting for messages to come in. For each message that is received, the handler will be called with the body of the message as a JSON object. You are required to return a promise from your handler that resolves when the work for this message is completed. After the promise resolves, `@meadow/sqs` will automatically delete the message from the SQS queue.
+
+- `options` - These options will be sent to the Amazon SQS `receiveMessage` function defined here: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html#receiveMessage-property
+- `handler` - A function that returns a promise, which is meant to handle the message. The first parameter will be the message body as a JSON object.
diff --git a/package.json b/package.json
index e615f08..986153a 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@meadow/sqs",
   "version": "1.0.0",
-  "description": "Client for Amazon SQS with built-in long polling.",
+  "description": "Promise/JSON based client for Amazon SQS with automatic long-polling.",
   "main": "index.js",
   "scripts": {
     "cover": "nyc ava",