From aee9ce62107b88e2e503d194f21da2be8fff4d98 Mon Sep 17 00:00:00 2001 From: Scott Nelson Date: Thu, 1 Oct 2015 16:09:38 -0400 Subject: [PATCH] Added badges to README --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 538301f..3a67a13 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ monq Monq is a MongoDB-backed job queue for Node.js. +[![NPM](https://img.shields.io/npm/v/monq.svg?style=flat)](http://npm.im/monq) +[![Build Status](https://img.shields.io/travis/scttnlsn/monq.svg?style=flat)](https://travis-ci.org/scttnlsn/monq) + Usage ----- @@ -12,7 +15,7 @@ Connect to MongoDB by specifying a URI or providing `host`, `port` and `database var monq = require('monq'); var client = monq('mongodb://localhost:27017/monq_example'); ``` - + Enqueue jobs by supplying a job name and a set of parameters. Below, the job `reverse` is being placed into the `example` queue: ```javascript @@ -44,7 +47,7 @@ worker.start(); Events ------ - + Workers will emit various events while processing jobs: ```javascript @@ -53,12 +56,12 @@ worker.on('failed', function (data) { … }); worker.on('complete', function (data) { … }); worker.on('error', function (err) { … }); ``` - + Install ------- npm install monq - + Tests ----- @@ -66,4 +69,4 @@ Tests You can optionally specify the MongoDB URI to be used for tests: - MONGODB_URI=mongodb://localhost:27017/monq_tests make test \ No newline at end of file + MONGODB_URI=mongodb://localhost:27017/monq_tests make test