Skip to content

Commit

Permalink
docs: use ESM syntax for default instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nihalgonsalves committed Jan 15, 2024
1 parent e8d8bb8 commit ae9def4
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ yarn add esbuild-plugin-browserslist esbuild browserslist
## Usage

```ts
const esbuild = require("esbuild");
const browserslist = require("browserslist");
const {
import esbuild from "esbuild";
import browserslist from "browserslist";
import {
esbuildPluginBrowserslist,
resolveToEsbuildTarget,
} = require("esbuild-plugin-browserslist");
} from "esbuild-plugin-browserslist";

await esbuild.build({
entryPoints: ["./foo/bar.ts"],
Expand All @@ -42,6 +42,22 @@ await esbuild.build({
});
```

<details>
<summary>:information_source: CJS usage instructions</summary>

Adjust the imports as follows:

```ts
const esbuild = require("esbuild");
const browserslist = require("browserslist");
const {
esbuildPluginBrowserslist,
resolveToEsbuildTarget,
} = require("esbuild-plugin-browserslist");
```

</details>

## Caveats

- Only `edge`, `firefox`, `chrome`, `safari`, `ios_saf`, and `node` have direct equivalents for esbuild targets.
Expand Down

0 comments on commit ae9def4

Please sign in to comment.