Skip to content

Commit

Permalink
docs: mention unplugin, remove roadmap, update example
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe committed Aug 29, 2024
1 parent 03148b5 commit 4ad7be0
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

> Builder-agnostic plugin to allow restricting import patterns in certain parts of your code-base.
This package is an [unplugin](https://unplugin.unjs.io/) which provides support for a wide range of bundlers.

## Usage

Install package:
Expand All @@ -17,11 +19,11 @@ npm install impound
```

```js
// rollup.config.js
import { dirname } from 'node:path'
import { ImpoundPlugin } from 'impound'

const build = await rollup({
input: 'entry.js',
export default {
plugins: [
ImpoundPlugin.rollup({
cwd: dirname(import.meta.url),
Expand All @@ -32,16 +34,9 @@ const build = await rollup({
]
}),
],
})
}
```
## 🚧 TODO
- [x] add docs
- [x] update playground
- [x] push to GitHub
- [ ] migrate to `unjs/`
## 💻 Development
- Clone this repository
Expand Down

0 comments on commit 4ad7be0

Please sign in to comment.