summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2019-05-19 19:16:16 -0700
committerAlexander Early <alexander.early@gmail.com>2019-05-19 19:16:16 -0700
commit012acbb279b3be0932ea0179fa7c1baf4cdaa50f (patch)
tree76e6681c3c366c8e0a6dc58ce74856ca8fc3ee9c
parentde383130194069a957d2ce72eccd22b6783ca005 (diff)
downloadasync-module-pkg.tar.gz
update docsmodule-pkg
-rw-r--r--README.md4
-rw-r--r--intro.md4
2 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8baf486..e137db3 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,9 @@
[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/async/badge?style=rounded)](https://www.jsdelivr.com/package/npm/async)
-Async is a utility module which provides straight-forward, powerful functions for working with [asynchronous JavaScript](http://caolan.github.io/async/global.html). Although originally designed for use with [Node.js](https://nodejs.org/) and installable via `npm install async`, it can also be used directly in the browser.
+Async is a utility module which provides straight-forward, powerful functions for working with [asynchronous JavaScript](http://caolan.github.io/async/global.html). Although originally designed for use with [Node.js](https://nodejs.org/) and installable via `npm install async`, it can also be used directly in the browser. A ESM version is included in the main `async` package that should automatically be used with compatible bundlers such as Webpack and Rollup.
-This version of the package is optimized for the Node.js environment. If you use Async with webpack, install [`async-es`](https://www.npmjs.com/package/async-es) instead.
+A pure ESM version of Async is available as [`async-es`](https://www.npmjs.com/package/async-es).
For Documentation, visit <https://caolan.github.io/async/>
diff --git a/intro.md b/intro.md
index 0638077..f1ec5e9 100644
--- a/intro.md
+++ b/intro.md
@@ -264,7 +264,9 @@ included in the `/dist` folder. Async can also be found on the [jsDelivr CDN](ht
### ES Modules
-We also provide Async as a collection of ES2015 modules, in an alternative `async-es` package on npm.
+Async includes a `.mjs` version that should automatically be used by compatible bundlers such as Webpack or Rollup, anything that uses the `module` field of the `package.json`.
+
+We also provide Async as a collection of purely ES2015 modules, in an alternative `async-es` package on npm.
```bash
$ npm install async-es