Skip to content

Commit

Permalink
docs(readme): fill in usage
Browse files Browse the repository at this point in the history
  • Loading branch information
favna committed Oct 7, 2022
1 parent 2225ad7 commit 12a34fb
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Expand Up @@ -49,11 +49,39 @@ npm install -D esbuild-plugin-version-injector

### With [`esbuild`][esbuild]

TODO
Add the plugin to your esbuild options, i.e.:

```js
const esbuild = require('esbuild');
const { resolve } = require('path');
const {
esbuildPluginVersionInjector
} = require('esbuild-plugin-version-injector');

await esbuild.build({
format: 'cjs',
entryPoints: [resolve(__dirname, './src/index.ts')],
outdir: resolve(__dirname, './dist'),
plugins: [esbuildPluginVersionInjector()]
});
```

### With [`tsup`][tsup]

TODO
Add the plugin to your `tsup.config.ts`, i.e.:

```js
import { defineConfig } from 'tsup';
import { resolve } from 'path';
import { esbuildPluginVersionInjector } from 'esbuild-plugin-version-injector';

await defineConfig({
format: ['cjs'],
entry: ['./src/index.ts'],
outDir: './dist',
esbuildPlugins: [tsBasedEsbuildPluginVersionInjector()]
});
```

[esbuild]: https://esbuild.github.io/
[tsup]: https://tsup.egoist.dev
Expand Down

0 comments on commit 12a34fb

Please sign in to comment.