Skip to content

Commit 029e715

Browse files
committed
2 parents 9754c7d + c60e2d9 commit 029e715

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,29 @@
66
[![Version: npm](https://img.shields.io/npm/v/bun-plugin-coffeescript?style=for-the-badge)](https://www.npmjs.org/package/bun-plugin-coffeescript)
77
![GitHub branch check runs](https://img.shields.io/github/check-runs/idleberg/bun-plugin-coffeescript/main?style=for-the-badge)
88

9-
## Installation
9+
This plugin provides support for both CoffeeScript and CSON to your Bun projects. It is roughly modelled after the [esbuild-coffeescript](https://www.npmjs.com/package/esbuild-coffeescript) and is still in its infancy. Your feedback or contribution is welcome!
10+
11+
## Installation 💿
1012

1113
```shell
1214
bun install bun-plugin-coffeescript
1315
```
1416

15-
## Usage
17+
## Usage 🚀
1618

17-
```ts
18-
import CoffeePlugin from "bun-plugin-coffeescript";
19+
```typescript
20+
import CoffeeScript from "bun-plugin-coffeescript";
1921

2022
Bun.build({
2123
entrypoints: ["app.coffee"],
2224
outdir: "dist",
2325
target: "browser",
2426
plugins: [
25-
CoffeePlugin(/* compiler options */),
27+
CoffeeScript(/* compiler options */),
2628
],
2729
});
2830
```
2931

30-
## License
32+
## License ©️
3133

3234
This work is licensed under [The MIT License](LICENSE).

0 commit comments

Comments
 (0)