From b7f92ee20a6aea1a7c672ade07162ac14292edbe Mon Sep 17 00:00:00 2001 From: Lance Ball Date: Wed, 26 Oct 2016 13:55:46 -0400 Subject: [PATCH] Update readme --- README.md | 20 ++++++++++++++++++-- package.json | 1 + 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2da504c..22e09be 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ [![NPM](https://nodei.co/npm/fidelity.png)](https://npmjs.org/package/fidelity) -A fast and simple Promise/A+ implementation. +A fast and simple Promise/A+ implementation capable of Node.js or browser-based +execution. `Fidelity` adheres to both the Promise/A+ specspecification, and the +ES6 `Promise` API in its entirety. | | Project Info | | --------------- | ------------- | @@ -19,7 +21,21 @@ A fast and simple Promise/A+ implementation. ## Installation -`npm install fidelity` +Fidelity can be used in Node.js. + +````shell +$ npm install fidelity +```` + +Or in the browser. + +````html + + +```` + +When used in the browser, a `FidelityPromise` object is created in the +`global` scope. ## Usage diff --git a/package.json b/package.json index 8826c9d..ce4f7d0 100644 --- a/package.json +++ b/package.json @@ -26,6 +26,7 @@ "README.md", "LICENSE.txt", "browser", + "browser.tar.gz", "lib" ], "keywords": [