Skip to content

Commit 8ffe16b

Browse files
committed
add the butter enums to the docs package.json
1 parent 85434b0 commit 8ffe16b

3 files changed

Lines changed: 40 additions & 4 deletions

File tree

docs/index.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,36 @@ import { ButterKeyedEnum, ButterTupleEnum } from "butter-enums"
2828

2929
## Tuple Enums
3030
```ts twoslash
31-
import { ButterTupleEnum } from "../src/index"
32-
// ---cut---
31+
import { ButterTupleEnum } from "butter-enums"
32+
3333
const test = ButterTupleEnum(['blue', 'green', 'red'])
3434

3535
console.log(test.tuple)
3636
// ^?
3737

3838

39+
40+
41+
42+
43+
3944
console.log(test.enum)
4045
// ^?
4146
```
4247
<br />
48+
<br />
49+
<br />
50+
<br />
51+
<br />
52+
<br />
53+
<br />
54+
<br />
4355

4456

4557
## Keyed Enums
4658
```ts twoslash
47-
import { ButterKeyedEnum } from "../src/index"
48-
// ---cut---
59+
import { ButterKeyedEnum } from "butter-enums"
60+
4961
const test = ButterKeyedEnum({
5062
green: {
5163
emoji: '🟩',

docs/package-lock.json

Lines changed: 21 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,8 @@
77
"devDependencies": {
88
"@shikijs/vitepress-twoslash": "^3.5.0",
99
"vitepress": "^1.6.3"
10+
},
11+
"dependencies": {
12+
"butter-enums": "^0.0.1"
1013
}
1114
}

0 commit comments

Comments
 (0)