diff --git a/README.md b/README.md index 7656f2e..4d997c7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # bannana pho -ring ring \ No newline at end of file +[ring ring](https://gitlab.com/litecord/litecord) + +--- + +### Environment Variables: + +(Also found in `example.env`) + +| Variable | Description | Example | +|:--------------------:|:------------------------------------------------------------:|:----------------:| +| `LISTEN_ADDR` | Listen address of the websocket | `0.0.0.0:3621` | +| `REDIS_ADDR` | Redis database address (not yet used) | `127.0.0.1:6379` | +| `SECRET` | Shared Secret, can be anything, must be the same on Litecord | `deez nuts 420` | +| `HEARTBEAT_INTERVAL` | Rate of which Litecord will send a heartbeat (in seconds) | `1` | \ No newline at end of file diff --git a/example.env b/example.env new file mode 100644 index 0000000..29be683 --- /dev/null +++ b/example.env @@ -0,0 +1,4 @@ +LISTEN_ADDR= +REDIS_ADDR= +SECRET= +HEARTBEAT_INTERVAL= \ No newline at end of file