Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jimf committed Jan 8, 2016
1 parent ac19505 commit 5c6c2a6
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# deferred-as-promise

Wrap a deferred as a native `Promise`.

[![npm Version][npm-badge]][npm]
[![Build Status][build-badge]][build-status]
[![Test Coverage][coverage-badge]][coverage-result]
[![Dependency Status][dep-badge]][dep-status]

## Installation

Install using npm:

$ npm install deferred-as-promise

## Usage

```js
var $ = require('jquery');
var deferredAsPromise = require('deferred-as-promise');

deferredAsPromise($.ajax({
url: 'https://randomuser.me/api/',
dataType: 'json'
})).then(function(result) {
console.log(result);
}).catch(function(err) {
console.error(err);
});
```

## License

MIT

[build-badge]: https://img.shields.io/travis/jimf/deferred-as-promise/master.svg
[build-status]: https://travis-ci.org/jimf/deferred-as-promise
[npm-badge]: https://img.shields.io/npm/v/deferred-as-promise.svg
[npm]: https://www.npmjs.org/package/deferred-as-promise
[coverage-badge]: https://img.shields.io/coveralls/jimf/deferred-as-promise.svg
[coverage-result]: https://coveralls.io/r/jimf/deferred-as-promise
[dep-badge]: https://img.shields.io/david/jimf/deferred-as-promise.svg
[dep-status]: https://david-dm.org/jimf/deferred-as-promise

0 comments on commit 5c6c2a6

Please sign in to comment.