doc: add info on README

rvagg · Jan 10, 2024 · 8d2e118 · 8d2e118
1 parent 8a5eac4
commit 8d2e118
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
+***`@rvagg/chai-as-promised` is a fork of [chai-as-promised](https://github.com/domenic/chai-as-promised) converted to ESM, supports Chai v5+ and bundles types natively.***
+
+```js
+import * as chai from "chai"
+import chaiAsPromised from "chai-as-promised"
+
+chai.use(chaiAsPromised);
+const { assert, expect } = chai;
+```
+
 <a href="http://promisesaplus.com/">
     <img src="https://promises-aplus.github.io/promises-spec/assets/logo-small.png"
          align="right" valign="top" alt="Promises/A+ logo" />