Skip to content

Commit

Permalink
updating as per review
Browse files Browse the repository at this point in the history
  • Loading branch information
mhmohona committed Jul 25, 2023
1 parent ab6d277 commit 4190553
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 20
---


The AsyncAPI CLI is a command-line tool that provides developers with a set of commands for working with AsyncAPI documents. AsyncAPI is a specification for describing asynchronous APIs, which allows developers to define the structure of messages exchanged between different parts of their application. The AsyncAPI CLI simplifies the process of creating, validating, bundling, and manipulating AsyncAPI documents, making it easier to work with asynchronous APIs.
The AsyncAPI CLI is a command-line tool that provides a set of commands for working with AsyncAPI documents. AsyncAPI is a specification for describing asynchronous APIs, which allows developers to define the structure of messages exchanged between different parts of their application. The AsyncAPI CLI simplifies the process of creating, validating, bundling, and manipulating AsyncAPI documents, making it easier to work with asynchronous APIs.

## Features

Expand All @@ -24,8 +24,6 @@ The AsyncAPI CLI offers the following key features:

* Start: The AsyncAPI CLI can be used to start [AsyncAPI Studio](https://studio.asyncapi.com/) locally. This is a web-based tool that can be used to view, edit, and test AsyncAPI documents.

* Format Conversion: The AsyncAPI CLI offers seamless conversion of AsyncAPI documents between different formats, such as YAML and JSON, through integration with the [AsyncAPI Converter](https:/asyncapi/converter-js). This feature is helpful when working with tools that require a specific document format.

To summarize, the AsyncAPI CLI offers the following features and process flow, as shown in the diagram below:

```mermaid
Expand Down Expand Up @@ -69,7 +67,6 @@ F --> |Operation Error| H[CLI displays an error message and suggests possible ne
G --> J[User receives the results]
H --> I[User follows suggested steps to recover]
I --> C[User reissues the corrected command]
I --> J
J[User terminates the AsyncAPI CLI] --> K[End]
```

Expand Down

0 comments on commit 4190553

Please sign in to comment.