From 012acbb279b3be0932ea0179fa7c1baf4cdaa50f Mon Sep 17 00:00:00 2001 From: Alexander Early Date: Sun, 19 May 2019 19:16:16 -0700 Subject: update docs --- README.md | 4 ++-- intro.md | 4 +++- 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 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 -- cgit v1.2.1