diff --git a/README.md b/README.md index ccf67ea..9c0f154 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,18 @@ Chat app to talk in group or to strangers ## Running -Export SALT as environment variable to use as salt for hashing, and TENOR_API_KEY for gifs support in the server. +Create a `config.json` file for configuring the server with all the required options like `salt` and `tenor_api` etc. +An example config file `config.json.example` has been provided with all currently supported options, one can copy the example file as `config.json` +and put appropriate values for the given options to get the config file ready for use. ``` -SALT="" TENOR_API_KEY="API-KEY" lupt --bind_address : --static_path +lupt -a -p -s -c ``` Example: ``` -SALT="sometext" TENOR_API_KEY="API-KEY" lupt --bind_address 0.0.0.0:8080 --static_path ./static +lupt -a 0.0.0.0 -p 8080 -s ./static -c config.json ``` ## Building