Skip to content

Commit 59b9341

Browse files
committed
update readme
1 parent 4357131 commit 59b9341

File tree

3 files changed

+23
-136
lines changed

3 files changed

+23
-136
lines changed

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
11
[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/asyncapi)](https://api.reuse.software/info/github.com/cap-js/asyncapi)
22

3-
# AsyncAPI Plugin
3+
# AsyncAPI
4+
5+
## About this project
46

57
The `@cap-js/asyncapi` is a package that provides support for AsyncAPI document compilation.
68

79
### Table of Contents
810

11+
- [Requirements and Setup](#requirements-and-setup)
912
- [Generate AsyncAPI document](#generate-asyncapi-document)
1013
- [Contributing](#contributing)
1114
- [Code of Conduct](#code-of-conduct)
1215
- [Licensing](#licensing)
1316

17+
## Requirements and Setup
18+
19+
### Installation
20+
21+
```sh
22+
$ npm install @cap-js/asyncapi
23+
```
24+
25+
### Usage
26+
27+
```sh
28+
require("@cap-js/asyncapi").registerAsyncapiCompileTarget()
29+
```
30+
1431
## Generate AsyncAPI document
1532

1633
### 1. Usage of programatic API
@@ -29,7 +46,7 @@ For more information, visit [capire](https://cap.cloud.sap/docs/node.js/cds-comp
2946
Run the following command in the CLI to generate the AsyncAPI document.
3047

3148
```sh
32-
cds compile <filename> --to asyncapi
49+
$ cds compile <filename> --to asyncapi
3350
```
3451

3552

@@ -41,7 +58,7 @@ This project is open to feature requests/suggestions, bug reports etc. via [GitH
4158

4259
## Code of Conduct
4360

44-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
61+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
4562

4663
## Licensing
4764

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717
"license": "SEE LICENSE IN LICENSE",
1818
"main": "index.js",
1919
"files": [
20-
"lib/"
20+
"lib/",
21+
"npm-shrinkwrap.json",
22+
"LICENSE"
2123
],
2224
"scripts": {
2325
"test": "npx jest --silent",

0 commit comments

Comments
 (0)