From e68f9004a8dec61b27c768c9e8dc70761b12ffe6 Mon Sep 17 00:00:00 2001 From: souvik Date: Tue, 16 May 2023 18:12:30 +0530 Subject: [PATCH] feat: remove under development from documentation (#430) --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8c90ab7c4..5fd734532 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,11 @@ ![Glee — The AsyncAPI framework that will make you smile again.](assets/readme-banner.png) + [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) [![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: @@ -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