Skip to content

Commit ef8d3ac

Browse files
committed
chore: update readme
1 parent 201f369 commit ef8d3ac

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,9 @@ Your automated markdown maintainer!
1212

1313
Create a section in your `README.md`:
1414

15-
```md
16-
## Utils
17-
18-
<!-- AUTOMD_START generator="jsdocs" src="./src/index" -->
19-
<!-- AUTOMD_END -->
20-
```
15+
## Utils
16+
<!-- AUTOMD_START generator="jsdocs" src="./src/index" -->
17+
<!-- AUTOMD_END -->
2118

2219
Make sure to have some utility exports in `src/index.ts` annotated with JSDocs.
2320

@@ -27,9 +24,25 @@ Now invoke `automd`:
2724
npx automd@latest
2825
```
2926

30-
The declared section will be automatically updated! See [./playground](./playground/) for output!
27+
The declared section will be automatically updated!
28+
29+
## Utils
30+
31+
<!-- AUTOMD_START generator="jsdocs" src="./src/index" -->
32+
33+
### `add(a, b)`
34+
35+
Adds two numbers together.
36+
37+
**Example:**
38+
```js
39+
add(1, 2); // 3
40+
```
3141

32-
Behind the scenes, audomd uses [untyped](https://untyped.unjs.io/) and [jiti](https://github.com/unjs/jiti) loader for JSDocs parsing and TypeScript support .
42+
<!-- AUTOMD_END -->
43+
44+
> [!NOTE]
45+
> automd uses [untyped](https://untyped.unjs.io/) and [jiti](https://github.com/unjs/jiti) loader for JSDocs parsing and TypeScript support .
3346
3447
### Supported Args
3548

@@ -56,3 +69,7 @@ Published under [MIT License](./LICENSE).
5669
[npm-version-href]: https://npmjs.com/package/automd
5770
[npm-downloads-src]: https://img.shields.io/npm/dm/automd?style=flat&colorA=18181B&colorB=F0DB4F
5871
[npm-downloads-href]: https://npmjs.com/package/automd
72+
73+
```
74+
75+
```

0 commit comments

Comments
 (0)