Skip to content
This repository has been archived by the owner on Nov 15, 2018. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lance committed Oct 26, 2016
1 parent a406ca5 commit b7f92ee
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| --------------- | ------------- |
Expand All @@ -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
<!-- load fidelity -->
<script src="fidelity-promise-min.js"></script>
````

When used in the browser, a `FidelityPromise` object is created in the
`global` scope.

## Usage

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"README.md",
"LICENSE.txt",
"browser",
"browser.tar.gz",
"lib"
],
"keywords": [
Expand Down

0 comments on commit b7f92ee

Please sign in to comment.