Skip to content

Commit 09f1495

Browse files
author
Jason Walton
committed
Add some documentation.
1 parent 2701081 commit 09f1495

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

DEVELOPMENT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
The intention here is to mirror the API of other existing projects, such as
2+
[bluebird](https://github.com/petkaantonov/bluebird) and [q](https://github.com/kriskowal/q), but to make this
3+
agnostic to the Promise implementation. When adding a new function, try to use the same API as these other libraries,
4+
to make migration to `promise-tools` easy. You can assume that `Promise` has any and all functions available
5+
in the ECMAScript 2015 standard.
6+
7+
All source files should run in the latest node.js without any translation using `babel`. We do use `babel` to
8+
generate ES5 source files in `lib`, and this is what gets distributed, but `npm run quicktest` will attempt to
9+
run tests without involving `babel` (as `bable` is quite slow.) Note that all tests are run on the CI server
10+
using babel translated code.

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Copyright (c) 2015 Benbria
2+
3+
Permission is hereby granted, free of charge, to any person
4+
obtaining a copy of this software and associated documentation
5+
files (the "Software"), to deal in the Software without
6+
restriction, including without limitation the rights to use,
7+
copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the
9+
Software is furnished to do so, subject to the following
10+
conditions:
11+
12+
The above copyright notice and this permission notice shall be
13+
included in all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)