Skip to content

Commit c52c773

Browse files
authored
Polish w emojis
1 parent c67d926 commit c52c773

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ and infers type data from TypeScript definitions.
3232

3333
You can checkout the documentation for `example/` [here](https://webdoc-labs.github.io/example-documentation/index.html)!
3434

35-
## Usage
35+
## Usage :newspaper_roll:
3636

3737
```shell
38-
npm install -g @webdoc/cli
38+
npm install --save-dev @webdoc/cli
3939
```
4040

4141
To get started, create a `webdoc.conf.json` file in your project directory.
@@ -63,7 +63,7 @@ The only required field is `source.include` which tells webdoc where the source
6363

6464
You can now run `webdoc` in your terminal and documentation will be generated. Be sure to serve the documentation from the folder it is generated in. If you need to serve from an ancestor directory, provide the documentation path relative to the root using the `--site-root` option, e.g. `webdoc --site-root docs`.
6565

66-
## Packages
66+
## Packages :package:
6767

6868
| Packages | npm ||
6969
|-----------------------------|------------------------------------------------------------------|-|
@@ -76,7 +76,7 @@ You can now run `webdoc` in your terminal and documentation will be generated. B
7676
| [@webdoc/legacy-template](packages/webdoc-legacy-template) | ![npm](https://img.shields.io/npm/v/@webdoc/legacy-template) |![David (path)](https://img.shields.io/david/webdoc-labs/webdoc?path=packages%2Fwebdoc-legacy-template)|
7777
| [@webdoc/default-template](packages/webdoc-default-template) | ![npm](https://img.shields.io/npm/v/@webdoc/default-template) |![David (path)](https://img.shields.io/david/webdoc-labs/webdoc?path=packages%2Fwebdoc-default-template)|
7878

79-
## Features
79+
## Features :tada:
8080

8181
* Support for JavaScript, Flow, and TypeScript. The modular structure of @webdoc/parser allows you to integrate it with other languages as well.
8282

0 commit comments

Comments
 (0)