Skip to content

Commit

Permalink
📎 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ycd committed Dec 7, 2020
1 parent fe43401 commit 803563d
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* #### Optional pre-commit hook generation.


## Installation
## Installation 📌

* Prerequisites
* Python 3.6 +
Expand All @@ -48,7 +48,7 @@ pip install manage-fastapi
```


## Getting started
## Getting started 🎈

Easiest way to start is using the defaults:

Expand All @@ -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.

<img src="docs/docs_assets/fastapi-help.png" width=700>
You can list them with

```bash
fastapi --help
```

<img src="docs/docs_assets/fastapi-help.png" width=600>

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

<img src="docs/docs_assets/startproject-help.png" width=700>
<img src="docs/docs_assets/startproject-help.png" width=600>

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:

Expand Down

0 comments on commit 803563d

Please sign in to comment.