Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README.md #482

Merged
merged 2 commits into from
Jul 26, 2023
Merged

docs: update README.md #482

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c52f67
docs: update readme, typo fix
AnimeshKumar923 Jul 26, 2023
5783413
update readme, fix typo, add suggestions
AnimeshKumar923 Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
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!