Update README

- Adds recommendation to use pipx (closes #20)
- Adds generated usage.md from typer-cli

Author: dbanty

README.md

@@ -19,7 +19,10 @@ Additionally, because this generator is written in Python, it should be more acc
 using it (Python developers).
 
 ## Installation
-`pip install openapi-python-client`
+I recommend you install with [pipx](https://pipxproject.github.io/pipx/)  so you don't conflict with any other packages 
+you might have: `pipx install openapi-python-client`.
+
+You can install with normal pip if you want to though: `pipx install openapi-python-client`
 
 Then, if you want tab completion: `openapi-python-client --install-completion`
 
@@ -34,6 +37,8 @@ get an error.
 ### Update an existing client
 `openapi-python-client update --url https://my.api.com/openapi.json`
 
+> For more usage details run `openapi-python-client --help` or read [usage](usage.md)
+
 ## What You Get
 1. A `pyproject.toml` file with some basic metadata intended to be used with [Poetry].
 1. A `README.md` you'll most definitely need to update with your project's details

openapi_python_client/cli.py

@@ -6,7 +6,7 @@
 app = typer.Typer()
 
 
-def _version_callback(value: bool):
+def _version_callback(value: bool) -> None:
     from openapi_python_client import __version__
 
     if value:
@@ -15,9 +15,9 @@ def _version_callback(value: bool):
 
 
 # noinspection PyUnusedLocal
-@app.callback()
+@app.callback(name="openapi-python-client")
 def cli(
-    version: bool = typer.Option(False, "--version", callback=_version_callback),
+    version: bool = typer.Option(False, "--version", callback=_version_callback, help="Print the version and exit"),
 ) -> None:
     """ Generate a Python client from an OpenAPI JSON document """
     pass

usage.md

@@ -0,0 +1,54 @@
+# `openapi-python-client`
+
+Generate a Python client from an OpenAPI JSON document 
+
+**Usage**:
+
+```console
+$ openapi-python-client [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+* `--version`: Print the version and exit
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+
+* `generate`: Generate a new OpenAPI Client library
+* `update`: Update an existing OpenAPI Client library
+
+## `openapi-python-client generate`
+
+Generate a new OpenAPI Client library 
+
+**Usage**:
+
+```console
+$ openapi-python-client generate [OPTIONS]
+```
+
+**Options**:
+
+* `--url TEXT`: A URL to read the JSON from
+* `--path PATH`: A path to the JSON file
+* `--help`: Show this message and exit.
+
+## `openapi-python-client update`
+
+Update an existing OpenAPI Client library 
+
+**Usage**:
+
+```console
+$ openapi-python-client update [OPTIONS]
+```
+
+**Options**:
+
+* `--url TEXT`: A URL to read the JSON from
+* `--path PATH`: A path to the JSON file
+* `--help`: Show this message and exit.
+