Skip to content

Commit 7ca3c97

Browse files
committed
docs: add todo section in readme
1 parent 0bff711 commit 7ca3c97

File tree

2 files changed

+60
-8
lines changed

2 files changed

+60
-8
lines changed

README.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,22 @@ codes in BDD style.
66
> [!WARNING]\
77
> Alpha version. Not tested extensively yet. APIs may change frequently.
88
9-
As an example, the usage below is generated from the actual tests with `bddoc`
10-
itself.
11-
129
## Usage
1310

11+
### Deno
12+
13+
```sh
14+
deno add jsr:@chiezo/bddoc
15+
```
16+
17+
## APIs
18+
19+
> [!NOTE]\
20+
> This section is generated with `bddoc` itself from `transform_test.ts` and
21+
> `parse_test.ts`.
22+
1423
```typeScript
15-
import { parse, transform } from "jsr:@chiezo/bddoc";
24+
import { parse, transform } from "@chiezo/bddoc";
1625
```
1726

1827
### `transform`
@@ -59,3 +68,20 @@ assertObjectMatch(describes[1], {
5968
],
6069
});
6170
```
71+
72+
## Todo
73+
74+
- Runtimes
75+
- [ ] Browsers
76+
- [ ] Bun
77+
- [x] Deno
78+
- [ ] Node.js
79+
- Test Interfaces
80+
- [ ] `Deno.test`
81+
- [x] `describe` `it`
82+
- Assertion Interfaces
83+
- [ ] `@std/assert`
84+
- [ ] `expect`
85+
- Backend
86+
- [x] Built-in (rule-based)
87+
- [ ] LLM (?)

docs/readme.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,41 @@ codes in BDD style.
66
> [!WARNING]\
77
> Alpha version. Not tested extensively yet. APIs may change frequently.
88
9-
As an example, the usage below is generated from the actual tests with `bddoc`
10-
itself.
11-
129
## Usage
1310

11+
### Deno
12+
13+
```sh
14+
deno add jsr:@chiezo/bddoc
15+
```
16+
17+
## APIs
18+
19+
> [!NOTE]\
20+
> This section is generated with `bddoc` itself from `transform_test.ts` and
21+
> `parse_test.ts`.
22+
1423
```typeScript
15-
import { parse, transform } from "jsr:@chiezo/bddoc";
24+
import { parse, transform } from "@chiezo/bddoc";
1625
```
1726

1827
<!-- transform -->
1928

2029
<!-- parse -->
30+
31+
## Todo
32+
33+
- Runtimes
34+
- [ ] Browsers
35+
- [ ] Bun
36+
- [x] Deno
37+
- [ ] Node.js
38+
- Test Interfaces
39+
- [ ] `Deno.test`
40+
- [x] `describe` `it`
41+
- Assertion Interfaces
42+
- [ ] `@std/assert`
43+
- [ ] `expect`
44+
- Backend
45+
- [x] Built-in (rule-based)
46+
- [ ] LLM (?)

0 commit comments

Comments
 (0)