Browse files

Update README with some Promises/A+ stuff

  • Loading branch information...
1 parent e30beb9 commit 8898591d5817e8495a8380de3564e5f27953dfd3 @domenic committed Jan 13, 2013
Showing with 14 additions and 2 deletions.
  1. +14 −2
@@ -1,5 +1,9 @@
-Chai Assertions for Working with Promises
+<a href="">
+ <img src=""
+ align="right" valign="top" alt="Promises/A+ logo" />
+# Chai Assertions for Working with Promises
**Chai as Promised** extends [Chai][chai] with a fluent language for asserting facts about [promises][presentation].
@@ -170,6 +174,12 @@ This will pass any failures of the individual promise assertions up to the test
an `"expected promise to be fulfilled…"` message as would happen if you did
+### Compatibility
+Chai as Promised is compatible with all promises following the [Promises/A+ specification][spec]. Notably, jQuery's
+so-called “promises” are not up to spec, and Chai as Promised will not work with them. In particular, Chai as Promised
+makes extensive use of the standard [transformation behavior][] of `then`, which jQuery does not support.
## Installation and Setup
### Node
@@ -218,6 +228,8 @@ automatically plug in to Chai and be ready for use:
[Mocha as Promised]:
+[transformation behavior]:

0 comments on commit 8898591

Please sign in to comment.