Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
timgit committed Jun 19, 2016
1 parent 15b1a03 commit a070485
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ function ready() {
}
```

##Installation
`$ npm install pg-boss`
pg-boss is a message queue (aka job queue, task queue) built in Node.js on top of PostgreSQL in order to provide guaranteed messaging and asynchronous execution to your Node apps.

Why would you consider using this queue over others? Well, I will say this is a crowded space in npm, and I haven't personally used very many of them, but if you're already using Node and Postgres, you could avoid a conversation with Ops. I wrote this to remove a dependency on Redis (via the kue package), consolidating systems I have to support in production and well as upgrading to guaranteed message processing. This will likely cater to anyone already familiar with the simplicity of relational database semantics and operations (querying and backups, for example) as well as a low budget solution to a very common problem.

##Features
* Guaranteed delivery and finalizing of jobs using a promise API
Expand All @@ -44,6 +45,9 @@ function ready() {
* Node 0.10 or higher (It may work on older versions, but who's using < 0.10? :)
* Postgres 9.5 or higher (see background below for rationale)

##Installation
`$ npm install pg-boss`

##Documentation
* [Docs](https://github.com/timgit/pg-boss/wiki) - (in progress)

Expand Down

0 comments on commit a070485

Please sign in to comment.