Skip to content

Commit

Permalink
Some readme and changelong updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dsfields committed Dec 17, 2015
1 parent bfd97a8 commit a837eb0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Change Log

## 1.0.0
## 1.0

### 1.0.1
* Fixing a leak of the `arguments` object to avoid optimizing compiler bailouts.

### 1.0.0
* Initial release.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Couchbase Promises
A lightweight, drop-in replacement for the Couchnode module with added support for A+ Promises.

[![Build Status](https://secure.travis-ci.org/dsfields/couchbase-promises.svg)](https://travis-ci.org/dsfields/couchbase-promises)

## Overview
Just like the [Couchbase Node.js module](http://developer.couchbase.com/documentation/server/4.0/sdks/node-2.0/introduction.html), but with the addition of `*Async()` methods that return A+ Promises for all methods that contain a Node.js callback parameter. Both the normal Couchnode and the mock Couchnode APIs have been fully promisified.
Just like the [Couchbase Node.js SDK](http://developer.couchbase.com/documentation/server/4.0/sdks/node-2.0/introduction.html), but with the addition of `*Async()` methods that return A+ Promises for all methods that contain a Node.js callback parameter. Both the normal Couchnode and the mock Couchnode APIs have been fully promisified. This module functions as a drop-in replacement for the [couchbase](https://www.npmjs.com/package/couchbase) module.

The current version supports Couchbase Node.js SDK version 2.1.2.

Promises are created using the [Bluebird](http://bluebirdjs.com/docs/getting-started.html) Promises library.
Promises are created using the [Bluebird](http://bluebirdjs.com/docs/getting-started.html) Promises library. If you absolutely must use native ECMAScript Promises, then have a look at [couchbase-es-promises](https://www.npmjs.com/package/couchbase-promises). I _highly_ recommend avoiding couchbase-es-promises, as Bluebird is compatible with native promises, and offers [an order of magnitude more performance](https://github.com/petkaantonov/bluebird/tree/master/benchmark).

## General Usage
Usage is almost exactly the same as the native SDK, but with the added ability to use Promises instead of callbacks.
Expand Down

0 comments on commit a837eb0

Please sign in to comment.