Skip to content
This repository has been archived by the owner on Nov 6, 2019. It is now read-only.

Commit

Permalink
Added badges to README
Browse files Browse the repository at this point in the history
  • Loading branch information
scttnlsn committed Oct 1, 2015
1 parent d0087e4 commit aee9ce6
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----

Expand All @@ -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
Expand Down Expand Up @@ -44,7 +47,7 @@ worker.start();

Events
------

Workers will emit various events while processing jobs:

```javascript
Expand All @@ -53,17 +56,17 @@ worker.on('failed', function (data) { … });
worker.on('complete', function (data) { … });
worker.on('error', function (err) { … });
```

Install
-------

npm install monq

Tests
-----

npm test

You can optionally specify the MongoDB URI to be used for tests:

MONGODB_URI=mongodb://localhost:27017/monq_tests make test
MONGODB_URI=mongodb://localhost:27017/monq_tests make test

0 comments on commit aee9ce6

Please sign in to comment.