Skip to content

Commit 49730d2

Browse files
committed
Update README.md
1 parent cd5bf5e commit 49730d2

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ Docs Readme Markdown and JSON Generator for [Capacitor](https://capacitorjs.com/
99
- Ideal for formatted docs within Github and NPM readme landing pages
1010
- If you're looking for an entire docs site generator we recommend [TypeDoc](https://typedoc.org/) instead
1111

12+
```bash
13+
npm i @capacitor/docgen --save-dev
14+
```
1215

1316
## Example Readme File
1417

@@ -59,6 +62,17 @@ docgen --api HapticsPlugin --output-readme README.md
5962
| `--project` | `-p` | Path to the project's `tsconfig.json` file, same as the [project](https://www.typescriptlang.org/docs/handbook/compiler-options.html) flag for TypeScript's CLI. By default it'll attempt to find this file. |
6063

6164

65+
#### package.json script
66+
67+
```json
68+
{
69+
"scripts": {
70+
"docgen": "docgen --api HapticsPlugin --output-readme README.md"
71+
}
72+
}
73+
```
74+
75+
6276
## Related
6377

6478
- [Capacitor](https://capacitorjs.com/)

0 commit comments

Comments
 (0)