Merge branch 'release/1.0.1'

README.md

@@ -9,6 +9,10 @@ A very simplistic, but performant, remote worker system that uses AMQP to coordi
 | `develop` | [![CircleCI](https://circleci.com/gh/davesag/amqp-delegate/tree/develop.svg?style=svg)](https://circleci.com/gh/davesag/amqp-delegate/tree/develop) | [![codecov](https://codecov.io/gh/davesag/amqp-delegate/branch/develop/graph/badge.svg)](https://codecov.io/gh/davesag/amqp-delegate) | Work in progress |
 | `master` | [![CircleCI](https://circleci.com/gh/davesag/amqp-delegate/tree/master.svg?style=svg)](https://circleci.com/gh/davesag/amqp-delegate/tree/master) | [![codecov](https://codecov.io/gh/davesag/amqp-delegate/branch/master/graph/badge.svg)](https://codecov.io/gh/davesag/amqp-delegate) | Latest stable release |
 
+```
+npm install amqp-delegate
+```
+
 ## Worker
 
 ```
@@ -43,7 +47,6 @@ worker.stop().then(() => {
 const { makeDelegator } = require('amqp-delegate')
 
 const delegator = makeWorker({
-  exchange: <the name of the exchange to use> — defaults to '',
   url: <the url of the amqp server> - defaults to ampq://localhost,
   onError: err => { // optional
     console.error('A connection error happened', err) // or do something clever
@@ -69,6 +72,8 @@ delegator
 ### The worker
 
 ```
+const { makeWorker } = require('amqp-delegate')
+
 const task = (a, b) =>
   new Promise(resolve => setTimeout(() => resolve(a + b), 10))
 
@@ -96,6 +101,8 @@ worker
 ### The delegator
 
 ```
+const { makeDelegator } = require('amqp-delegate')
+
 const delegator = makeDelegator()
 
 delegator
@@ -109,11 +116,6 @@ delegator
   })
 ```
 
-## TODO
-
-* documentation
-* publish to npm
-
 ## Development
 
 ### Prerequisites

docker-compose.yml

@@ -5,7 +5,7 @@ volumes:
 
 services:
   amqp:
-    image: rabbitmq
+    image: rabbitmq:management-alpine
     ports:
       - 15672:15672
       - 5672:5672

package.json

@@ -1,11 +1,15 @@
 {
   "name": "amqp-delegate",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A very simplistic, but performant, remote worker system that uses AMQP to coordinate jobs.",
   "main": "src/index.js",
   "engines": {
     "node": ">= 10.15.0"
   },
+  "files": [
+    "/src",
+    "/CONTRIBUTING.md"
+  ],
   "scripts": {
     "eslint-check": "eslint --print-config .eslintrc.js | eslint-config-prettier-check",
     "lint": "eslint .",
@@ -41,7 +45,7 @@
     "eslint-plugin-standard": "^4.0.0",
     "faker": "^4.1.0",
     "husky": "^1.3.1",
-    "lint-staged": "^8.1.0",
+    "lint-staged": "^8.1.1",
     "mocha": "^6.0.0-1",
     "nyc": "^13.1.0",
     "prettier": "^1.16.1",

src/defaults.js

@@ -1,6 +1,5 @@
 const defaults = {
-  url: process.env.AMQP_URL || 'amqp://localhost',
-  exchange: ''
+  url: process.env.AMQP_URL || 'amqp://localhost'
 }
 
 module.export = defaults

src/errors.js

@@ -5,7 +5,8 @@ const ERRORS = {
   QUEUE_ALREADY_STARTED: 'Message Queue has already been started',
   QUEUE_NOT_STARTED: 'Message Queue has not been started',
   TASK_MISSING:
-    'You must provide an async pure function as a task for the worker to perform'
+    'You must provide an async pure function as a task for the worker to perform',
+  WRONG_CORRELATION_ID: 'The provided correlationId is incorrect'
 }
 
 module.exports = ERRORS