Skip to content

Commit

Permalink
docs: update README.md (#482)
Browse files Browse the repository at this point in the history
  • Loading branch information
AnimeshKumar923 authored Jul 26, 2023
1 parent 69e5b90 commit 9836cdc
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ asyncapi new glee

After the installation is complete, follow the instructions to start the development server.

> For more information on how to install AsynAPI CLI, you can review [CLI instalation documentation](https://www.asyncapi.com/docs/tools/cli/installation)
> For more information on how to install AsyncAPI CLI, you can review [CLI installation documentation](https://www.asyncapi.com/docs/tools/cli/installation)
## Getting started

Expand All @@ -33,14 +33,14 @@ After the installation is complete, follow the instructions to start the develop

## Generating documentation

When using spec-driven framework like Glee, it's always neccessary to have docs and code always in sync.
Glee will automatically generate documentation for your application and you can also generate your documentation yourself by running:
When using spec-driven framework like Glee, it's always necessary to have docs and code always in sync.
Glee will automatically generate documentation for your application or you can also generate your documentation yourself by running:

```bash
glee docs
```

You can also tweak Glee's default configuration for generating documentation here [Configuring your application](docs/config-file.md)
You can also tweak Glee's default configuration for generating documentation here: [Configuring your application](docs/config-file.md)
## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Expand All @@ -59,4 +59,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind is welcome!

0 comments on commit 9836cdc

Please sign in to comment.