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.

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: adds an installation guide #479

Merged
merged 13 commits into from
Sep 25, 2023
16 changes: 16 additions & 0 deletions docs/pages/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: 'Installation guide'
weight: 30
---

## Glee Installation

Before installing Glee into your project, make sure you have pre-installed [AsyncAPI CLI](https://github.com/asyncapi/cli) tool.

The best way to get started with Glee is by using AsyncAPI CLI, which sets up everything automatically for you.
To create a project, run:
```sh
asyncapi new glee
```

> For more information on how to install the AsynAPI CLI, you can review the [CLI installation guide](https://www.asyncapi.com/docs/tools/cli/installation).
afzal442 marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 9 additions & 0 deletions docs/pages/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
afzal442 marked this conversation as resolved.
Show resolved Hide resolved
title: 'Introduction'
weight: 20
---

[Glee](https://github.com/asyncapi/glee) is a spec-first framework that helps you build server-side applications. It leverages the AsyncAPI specification to make you more productive:

- Glee ensures your code and AsyncAPI definition are on par, eliminating the problem of outdated documentation. Glee takes care of this automatically for you.
afzal442 marked this conversation as resolved.
Show resolved Hide resolved
- Glee lets you focus on what matters and handles the rest for you. You only write the code for your business use-case. Glee takes care of performance, scalability, resilience, and everything you need to make your application production-ready.
14 changes: 14 additions & 0 deletions docs/pages/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: 'Usage'
weight: 20
---

Glee as a spec-driven framework, makes it easier to work with applications in Generating documentation.

While working with the CLI, 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:

```
glee docs
```

<!-- TODO -->