Skip to content

Commit

Permalink
docs: document
Browse files Browse the repository at this point in the history
  • Loading branch information
d4rkr00t committed Mar 11, 2021
1 parent 0b079c0 commit 63b70a0
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,12 @@ OPTIONS

### Extra JSDoc Tags

| Tag | Description |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `@usage` | Similar to example, but outlines the main example on how to use a CLI command. `@usage {cliName} build` |
| `@short` | Defines an alias (shortcut) for a parameter. `@short name=n` |
| `{cliName}` | A variable that will be replaced by the name of a CLI tool described in `package.json`. Supported by `@usage` and `@example` |
| Tag | Description |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `@param $inputs` | Indicates that command receives unnamed arguments |
| `@usage` | Similar to example, but outlines the main example on how to use a CLI command. `@usage {cliName} build` |
| `@short` | Defines an alias (shortcut) for a parameter. `@short name=n` |
| `{cliName}` | A variable that will be replaced by the name of a CLI tool described in `package.json`. Supported by `@usage` and `@example` |

## package.json

Expand Down

0 comments on commit 63b70a0

Please sign in to comment.