mirror of
https://github.com/maplibre/martin.git
synced 2024-12-19 04:41:46 +03:00
doc: update README.md
This commit is contained in:
parent
1e128a7bef
commit
a693634010
23
README.md
23
README.md
@ -17,10 +17,30 @@ brew install martin
|
||||
|
||||
## Usage
|
||||
|
||||
Martin requires a database connection string. It can be passed as a command-line argument or as a `DATABASE_URL` environment variable.
|
||||
|
||||
```shell
|
||||
martin postgres://postgres@localhost/db
|
||||
```
|
||||
|
||||
Martin also supports a list of options
|
||||
|
||||
```shell
|
||||
Usage:
|
||||
martin [options] [<connection>]
|
||||
martin -h | --help
|
||||
martin -v | --version
|
||||
|
||||
Options:
|
||||
-h --help Show this screen.
|
||||
-v --version Show version.
|
||||
--workers=<n> Number of web server workers.
|
||||
--pool_size=<n> Maximum connections pool size [default: 20].
|
||||
--keep_alive=<n> Connection keep alive timeout [default: 75].
|
||||
--listen_addresses=<n> The socket address to bind [default: 0.0.0.0:3000].
|
||||
--config=<path> Path to config file.
|
||||
```
|
||||
|
||||
## Environment variables
|
||||
|
||||
You can configure martin with environment variables
|
||||
@ -56,7 +76,8 @@ cargo build --release
|
||||
The binary will be available at `./target/release/martin`
|
||||
|
||||
```shell
|
||||
./target/release/martin postgres://postgres@localhost/db
|
||||
cd ./target/release/
|
||||
./martin postgres://postgres@localhost/db
|
||||
```
|
||||
|
||||
## Development
|
||||
|
Loading…
Reference in New Issue
Block a user