Skip to content

Commit ceefe93

Browse files
committed
Merge pull request #4 from fend25/fend25-readme-added-usage
Update README.md
2 parents 3624d40 + 96e1e12 commit ceefe93

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,38 @@ Install
1919
-------
2020

2121
npm install fast-async
22+
23+
24+
Usage
25+
-----
26+
27+
Just include the plugin to the babel options. Minimal `.babelrc` example:
28+
29+
{
30+
"plugins": ["fast-async"]
31+
}
32+
33+
That's all. Neither `babel-plugin-transform-runtime` nor `babel-polyfill` required.
34+
35+
With options:
36+
37+
{
38+
"plugins": [
39+
["fast-async", {
40+
"env": {
41+
"augmentObject": false,
42+
"dontMapStackTraces": false,
43+
"asyncStackTrace": false,
44+
"dontInstallRequireHook": false
45+
},
46+
"compiler": {
47+
"promises": true,
48+
"generators": false
49+
}
50+
}]
51+
]
52+
}
53+
2254

2355
Test
2456
----

0 commit comments

Comments
 (0)