UNPKG

3.06 kBMarkdownView Raw
1<a href="http://promisesaplus.com/">
2 <img src="http://promisesaplus.com/assets/logo-small.png" alt="Promises/A+ logo"
3 title="Promises/A+ 1.1 compliant" align="right" />
4</a>
5
6
7[![Build Status](https://travis-ci.org/petkaantonov/bluebird.svg?branch=master)](https://travis-ci.org/petkaantonov/bluebird)
8[![coverage-98%](https://img.shields.io/badge/coverage-98%25-brightgreen.svg?style=flat)](http://petkaantonov.github.io/bluebird/coverage/debug/index.html)
9
10**Got a question?** Join us on [stackoverflow](http://stackoverflow.com/questions/tagged/bluebird), the [mailing list](https://groups.google.com/forum/#!forum/bluebird-js) or chat on [IRC](https://webchat.freenode.net/?channels=#promises)
11
12# Introduction
13
14Bluebird is a fully featured promise library with focus on innovative features and performance
15
16See the [**bluebird website**](http://bluebirdjs.com/docs/getting-started.html) for further documentation, references and instructions. See the [**API reference**](http://bluebirdjs.com/docs/api-reference.html) here.
17
18For bluebird 2.x documentation and files, see the [2.x tree](https://github.com/petkaantonov/bluebird/tree/2.x).
19
20### Note
21
22Promises in Node.js 10 are significantly faster than before. Bluebird still includes a lot of features like cancellation, iteration methods and warnings that native promises don't. If you are using Bluebird for performance rather than for those - please consider giving native promises a shot and running the benchmarks yourself.
23
24# Questions and issues
25
26The [github issue tracker](https://github.com/petkaantonov/bluebird/issues) is **_only_** for bug reports and feature requests. Anything else, such as questions for help in using the library, should be posted in [StackOverflow](http://stackoverflow.com/questions/tagged/bluebird) under tags `promise` and `bluebird`.
27
28
29
30## Thanks
31
32Thanks to BrowserStack for providing us with a free account which lets us support old browsers like IE8.
33
34# License
35
36The MIT License (MIT)
37
38Copyright (c) 2013-2017 Petka Antonov
39
40Permission is hereby granted, free of charge, to any person obtaining a copy
41of this software and associated documentation files (the "Software"), to deal
42in the Software without restriction, including without limitation the rights
43to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
44copies of the Software, and to permit persons to whom the Software is
45furnished to do so, subject to the following conditions:
46
47The above copyright notice and this permission notice shall be included in
48all copies or substantial portions of the Software.
49
50THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
51IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
52FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
53AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
54LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
55OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
56THE SOFTWARE.
57