Skip to content

Commit a837eb0

Browse files
committed
Some readme and changelong updates
1 parent bfd97a8 commit a837eb0

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Change Log
22

3-
## 1.0.0
3+
## 1.0
4+
5+
### 1.0.1
6+
* Fixing a leak of the `arguments` object to avoid optimizing compiler bailouts.
7+
8+
### 1.0.0
49
* Initial release.

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# Couchbase Promises
2-
A lightweight, drop-in replacement for the Couchnode module with added support for A+ Promises.
32

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

65
## Overview
7-
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.
6+
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.
87

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

11-
Promises are created using the [Bluebird](http://bluebirdjs.com/docs/getting-started.html) Promises library.
10+
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).
1211

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

0 commit comments

Comments
 (0)