Update README

This commit is contained in:
Giovanni Barillari 2023-05-09 14:31:56 +02:00
parent b9f4011142
commit 771eba3ce5

View file

@ -9,7 +9,7 @@ The main reasons behind Granian design are:
- Have a single, correct HTTP implementation, supporting versions 1, 2 (and eventually 3)
- Provide a single package for several platforms
- Avoid the usual Gunicorn + uvicorn + http-tools dependency composition on unix systems
- Provide stable performance when compared to existing alternatives
- Provide stable [performance](https://github.com/emmett-framework/granian/blob/master/benchmarks/README.md) when compared to existing alternatives
## Features
@ -66,6 +66,50 @@ and serve it using:
$ granian --interface rsgi main:app
## Options
You can check all the options provided by Granian with the `--help` command:
```shell
$ granian --help
Usage: granian [OPTIONS] APP
Arguments:
APP Application target to serve. [required]
Options:
--host TEXT Host address to bind to. [default:
127.0.0.1]
--port INTEGER Port to bind to. [default: 8000]
--interface [asgi|rsgi|wsgi] Application interface type. [default: rsgi]
--http [auto|1|2] HTTP version. [default: auto]
--ws / --no-ws Enable websockets handling [default:
(enabled)]
--workers INTEGER RANGE Number of worker processes. [default: 1;
x>=1]
--threads INTEGER RANGE Number of threads. [default: 1; x>=1]
--threading-mode [runtime|workers]
Threading mode to use. [default: workers]
--loop [auto|asyncio|uvloop] Event loop implementation [default: auto]
--backlog INTEGER RANGE Maximum number of connections to hold in
backlog. [default: 1024; x>=128]
--log-level [critical|error|warning|warn|info|debug]
Log level [default: info]
--log-config FILE Logging configuration file (json)
--ssl-keyfile FILE SSL key file
--ssl-certificate FILE SSL certificate file
--url-path-prefix TEXT URL path prefix the app is mounted on
--reload / --no-reload Enable auto reload on application's files
changes [default: no-reload]
--version Shows the version and exit.
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation.
--help Show this message and exit.
```
## Project status
Granian is currently under active development.