From 803563d5ad9a7eb7152ed02d3ccb4d015428d224 Mon Sep 17 00:00:00 2001 From: yagiz Date: Mon, 7 Dec 2020 23:25:14 +0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=8E=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 73e1dcf..482bbc7 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ * #### Optional pre-commit hook generation. -## Installation +## Installation 📌 * Prerequisites * Python 3.6 + @@ -48,7 +48,7 @@ pip install manage-fastapi ``` -## Getting started +## Getting started 🎈 Easiest way to start is using the defaults: @@ -64,15 +64,21 @@ fastapi startproject [name] --interactive -## Command line options +## Command line options 🧰 -Manage FastAPI has three commands for now. You can list them by running `fastapi --help`: +Manage FastAPI provides three different commands. - +You can list them with + +```bash +fastapi --help +``` + + The idea is to have a highly customizable CLI, but at the same time a simple interface for new users. You can see the available options for `startproject` running `fastapi startproject --help`: - + The other commands are already available but the current implementation is too shallow. More details about `startapp` and `run` commands will be provided once they have more functionalities, at the moment you can run `startapp` by just: