Skip to content

Commit e6b079b

Browse files
committed
docs: add usage description
1 parent 6550c1b commit e6b079b

1 file changed

Lines changed: 17 additions & 8 deletions

File tree

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,35 @@
11
# bun-plugin-coffeescript
22

3-
> Just my personal package template.
3+
> Use CoffeeScript with Bun, old meets new.
44
5-
[![License](https://img.shields.io/github/license/idleberg/node-package-template?color=blue&style=for-the-badge)](https://github.com/idleberg/node-package-template/blob/main/LICENSE)
6-
[![Version: npm](https://img.shields.io/npm/v/node-package-template?style=for-the-badge)](https://www.npmjs.org/package/node-package-template)
7-
![GitHub branch check runs](https://img.shields.io/github/check-runs/idleberg/node-package-template/main?style=for-the-badge)
5+
[![License](https://img.shields.io/github/license/idleberg/bun-plugin-coffeescript?color=blue&style=for-the-badge)](https://github.com/idleberg/bun-plugin-coffeescript/blob/main/LICENSE)
6+
[![Version: npm](https://img.shields.io/npm/v/bun-plugin-coffeescript?style=for-the-badge)](https://www.npmjs.org/package/bun-plugin-coffeescript)
7+
![GitHub branch check runs](https://img.shields.io/github/check-runs/idleberg/bun-plugin-coffeescript/main?style=for-the-badge)
88

99
## Description
1010

1111
A template with highly opinionated configuration. Works for me, maybe not for you!
1212

1313
## Installation
1414

15-
In GitHub, click on *"Use this template"* to create a new repo from this template. Alternatively, you can use degit.
16-
1715
```shell
18-
npx degit github:idleberg/node-package-template
16+
bun install bun-plugin-coffeescript
1917
```
2018

2119
## Usage
2220

23-
That's the one thing you have to figure out!
21+
```ts
22+
import CoffeePlugin from "bun-plugin-coffeescript";
23+
24+
Bun.build({
25+
entrypoints: ["app.coffee"],
26+
outdir: "dist",
27+
target: "browser",
28+
plugins: [
29+
CoffeePlugin(/* compiler options */),
30+
],
31+
});
32+
```
2433

2534
## License
2635

0 commit comments

Comments
 (0)