Skip to content

Commit

Permalink
feat: remove under development from documentation (asyncapi#430)
Browse files Browse the repository at this point in the history
  • Loading branch information
Souvikns authored May 16, 2023
1 parent 8387476 commit e68f900
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
![Glee — The AsyncAPI framework that will make you smile again.](assets/readme-banner.png)

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![Coverage Status](https://coveralls.io/repos/github/asyncapi/glee/badge.svg?branch=master)](https://coveralls.io/github/asyncapi/glee?branch=master)

> :warning: Glee is still under development, it didn't reach v1.0.0 and therefore is not suitable for production use yet.
> :warning: So far, it only supports MQTT and WebSockets (native, Socket.IO, and custom implementations).
## What's Glee?

Glee is a spec-first framework that helps you build server-side applications. It leverages the AsyncAPI specification to make you more productive:
Expand All @@ -18,15 +15,15 @@ Glee is a spec-first framework that helps you build server-side applications. It

## Setup

The best way to get started with Glee is using `create-glee-app`, which sets up everything automatically for you. To create a project, run:
The best way to get started with Glee is by using [AsyncAPI CLI](https://github.com/asyncapi/cli), which sets up everything automatically for you. To create a project, run:

```bash
npx create-glee-app
asyncapi new glee
```

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

For more information on how to use `create-glee-app`, you can review [the `create-glee-app` documentation](https://github.com/asyncapi/create-glee-app).
> For more information on how to install AsynAPI CLI, you can review [CLI instalation documentation](https://www.asyncapi.com/docs/tools/cli/installation)
## Getting started

Expand Down

0 comments on commit e68f900

Please sign in to comment.