Skip to content

Commit

Permalink
docs: add instructions for using AsyncAPI CLI (#433)
Browse files Browse the repository at this point in the history
  • Loading branch information
Arya-Gupta authored Jul 15, 2023
1 parent 85e2626 commit 2130f97
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,27 @@ HTML template for the [AsyncAPI Generator](https://github.com/asyncapi/generator
- [Usage](#usage)
- [Supported parameters](#supported-parameters)
- [Development](#development)
- [Contributors ✨](#contributors-%E2%9C%A8)
- [Contributors ✨](#contributors-)

<!-- tocstop -->

## Usage

Install AsyncAPI CLI

```bash
ag asyncapi.yaml @asyncapi/html-template -o output
npm install -g @asyncapi/cli
```

If you don't have the AsyncAPI Generator installed, you can install it like this:
Generate using CLI

```bash
npm install -g @asyncapi/generator
asyncapi generate fromTemplate <asyncapi.yaml> @asyncapi/[email protected]
```

You can replace `<asyncapi.yaml>` with local path or URL pointing to [any AsyncAPI document](https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka.yml).
Look into [Releases](/asyncapi/html-template/releases) of this template to pick up the version you need. It is not recommended to always use the latest in production. Always use a specific version.

## Supported parameters

| Name | Description | Required | Default | Allowed values | Example |
Expand Down

0 comments on commit 2130f97

Please sign in to comment.