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
18 changes: 18 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: 'Installation guide'
weight: 30
---

## Glee Installation

Before installing Glee framework into your project, make sure you have pre-installed AsyncAPI CLI tool under the hood.
afzal442 marked this conversation as resolved.
Show resolved Hide resolved

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

<Remember>
For more information on how to install AsynAPI CLI, you can review <a href="https://www.asyncapi.com/docs/tools/cli/installation">CLI installation documentation</a>.
</Remember>
afzal442 marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 9 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
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:
afzal442 marked this conversation as resolved.
Show resolved Hide resolved

- It makes sure 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.
afzal442 marked this conversation as resolved.
Show resolved Hide resolved