From ea35b8d8ae49ce8b1ca204741c2c975e53254939 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Tue, 24 Dec 2019 20:43:48 +0100 Subject: [PATCH] :memo: Update README with latest docs --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 01a6033..53fd5e3 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ --- -Typer is library to build CLI applications that users love using and developers love creating. Based on Python 3.6+ type hints. +Typer is library to build CLI applications that users will love using and developers will love creating. Based on Python 3.6+ type hints. -**Typer** is the little sibling of FastAPI. And it's intended to be the FastAPI of CLIs. +**Typer** is FastAPI's little sibling. And it's intended to be the FastAPI of CLIs. The key features are: @@ -34,13 +34,13 @@ The key features are: * **Easy to use**: It's easy to use for the final users. Automatic help commands, and (optional) automatic completion for all shells. * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs. * **Start simple**: The simplest example adds only 2 lines of code to your app: **1 import, 1 function call**. -* **Grow large**: Grow in complexity as much as you want create arbitrarily complex trees of commands and groups sub-commands, with options and arguments. +* **Grow large**: Grow in complexity as much as you want, create arbitrarily complex trees of commands and groups sub-commands, with options and arguments. ## Requirements Python 3.6+ -Typer stands on the shoulders of a giant. Internally it uses Click, that's the only dependency. +Typer stands on the shoulders of a giant. Its only internal dependency is Click. ## Installation @@ -112,7 +112,7 @@ Options: ## Example upgrade -The previous example was the extreme in terms of simplicity. +This was the simplest example possible. Now let's see one a bit more complex. @@ -280,14 +280,14 @@ For a more complete example including more features, see the Click internally. That's the only dependency. -But you can install extras: +But you can also install extras: -* colorama: and Click will automatically use it to make sure colors always work correctly, even in Windows. - * Then you can use any tool you want to output colors in all the systems, including the integrated `typer.style()` and `typer.secho()` (provided by Click). +* colorama: and Click will automatically use it to make sure your terminal's colors always work correctly, even in Windows. + * Then you can use any tool you want to output your terminal's colors in all the systems, including the integrated `typer.style()` and `typer.secho()` (provided by Click). * Or any other tool, e.g. wasabi, blessings. * click-completion: and Typer will automatically configure it to provide completion for all the shells, including installation commands. -You can install `typer` with `colorama` and `click-completion` with `pip3 install typer[all]`. +You can install `typer` with `colorama` and `click-completion` with `pip install typer[all]`. ## Other tools and plug-ins @@ -296,7 +296,7 @@ Click has many plug-ins available that you can use. And there are many tools tha For example: * click-spinner: to show the user that you are loading data. A Click plug-in. - * * There are several other Click plug-ins at click-contrib that you can explore. + * There are several other Click plug-ins at click-contrib that you can explore. * tabulate: to automatically display tabular data nicely. Independent of Click or typer. * etc... you can re-use many of the great available tools for building CLIs.