Skip to content

Commit 5941c2f

Browse files
authored
Merge pull request #14 from cap-js/readme-update
Update README.md
2 parents 5071bba + 2c927d1 commit 5941c2f

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `@cap-js/asyncapi` package is a [CDS plugin](https://cap.cloud.sap/docs/node
1414

1515
## Setup
1616

17-
To use `cds compile to asyncapi` functionality, simply add this self-configuring plugin package to your project:
17+
To use `cds compile --to asyncapi` functionality, simply add this self-configuring plugin package to your project:
1818

1919
```sh
2020
npm add @cap-js/asyncapi
@@ -26,16 +26,25 @@ In this guide, we use the [Incidents Management reference sample app](https://gi
2626

2727
### 1. Usage of programatic API
2828

29-
await `cds.compile(<file path>).to.asyncapi()` to invoke `cds compile to asyncapi` programatically.
29+
To invoke `cds compile --to asyncapi` programatically:
3030

31-
For more information, visit [CAPire](https://cap.cloud.sap/docs/node.js/cds-compile#to-asyncapi)
31+
```sh
32+
await cds.compile(<filename>).to.asyncapi()
33+
```
34+
35+
For more information, visit [capire](https://cap.cloud.sap/docs/node.js/cds-compile#to-asyncapi)
3236

3337

3438
### 2. Usage from CLI
3539

36-
Run `cds compile <file path> -2 asyncapi` in the CLI to generate the AsyncAPI document.
40+
Run the following command in the CLI to generate the AsyncAPI document.
41+
42+
```sh
43+
cds compile <filename> --to asyncapi
44+
```
45+
3746

38-
For more information, visit [CAPire](https://cap.cloud.sap/docs/advanced/asyncapi#cli)
47+
For more information, visit [capire](https://cap.cloud.sap/docs/advanced/publishing-apis/asyncapi#cli)
3948

4049
## Contributing
4150

@@ -47,4 +56,4 @@ We as members, contributors, and leaders pledge to make participation in our com
4756

4857
## Licensing
4958

50-
Copyright 2024 SAP SE or an SAP affiliate company and contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool]().
59+
Copyright 2024 SAP SE or an SAP affiliate company and contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/asyncapi).

0 commit comments

Comments
 (0)