diff --git a/README.md b/README.md new file mode 100644 index 0000000..89e847c --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Status page + +#### How to run server: + +```shell +./status server +``` + +#### How to run documentation server: + +```shell +./status server-docs +``` + +#### Example `--help` command: + +``` +0.0.1 +Usage: status [] + +Options: + --help, -h display this help and exit + --version display version and exit + +Commands: + server Start the api server + server-docs Generate documentation for api server +``` + +## Configuration + +To configure application follow these table of Env: + +| Name | Example | Definition | +|---------------|----------------|------------| +| DATABASE_HOST | localhost | - | +| DATABASE_PORT | 5432 | - | +| DATABASE_USER | someUserName | - | +| DATABASE_PASS | strongPassword | - | +| DATABASE_DB | statuspage | - | +| DATABASE_TZ | Europe/Moscow | - | \ No newline at end of file