Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeevitha011 committed May 2, 2024
1 parent 4357131 commit 59b9341
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 136 deletions.
132 changes: 0 additions & 132 deletions CODE_OF_CONDUCT.md

This file was deleted.

23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/asyncapi)](https://api.reuse.software/info/github.com/cap-js/asyncapi)

# AsyncAPI Plugin
# AsyncAPI

## About this project

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

### Table of Contents

- [Requirements and Setup](#requirements-and-setup)
- [Generate AsyncAPI document](#generate-asyncapi-document)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Licensing](#licensing)

## Requirements and Setup

### Installation

```sh
$ npm install @cap-js/asyncapi
```

### Usage

```sh
require("@cap-js/asyncapi").registerAsyncapiCompileTarget()
```

## Generate AsyncAPI document

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

```sh
cds compile <filename> --to asyncapi
$ cds compile <filename> --to asyncapi
```


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

## Code of Conduct

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.
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.

## Licensing

Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
"license": "SEE LICENSE IN LICENSE",
"main": "index.js",
"files": [
"lib/"
"lib/",
"npm-shrinkwrap.json",
"LICENSE"
],
"scripts": {
"test": "npx jest --silent",
Expand Down

0 comments on commit 59b9341

Please sign in to comment.