From a837eb0e38b526e6cf8a68f09254ac92f4e7ea49 Mon Sep 17 00:00:00 2001 From: dsfields Date: Thu, 17 Dec 2015 12:36:32 -0500 Subject: [PATCH] Some readme and changelong updates --- CHANGELOG.md | 7 ++++++- README.md | 5 ++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47f996b..2cf5bf3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. diff --git a/README.md b/README.md index 48b901f..182864c 100644 --- a/README.md +++ b/README.md @@ -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.