diff --git a/README.md b/README.md index 757d00d..4393834 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- +

A Spring Boot overlay server for Twitch broadcasters and their channel admins. Broadcasters can authorize via Twitch OAuth and invite channel admins to manage images that float over a transparent canvas. Updates are pushed in real time over WebSockets so OBS browser sources stay in sync. @@ -10,20 +10,20 @@ Define the following required environment variables: | Variable | Description | Example Value | |----------|-------------|---------------| -| IMGFLOAT_ASSETS_PATH | Filesystem path to store uploaded assets | /var/imgfloat/assets | -| IMGFLOAT_PREVIEWS_PATH | Filesystem path to store generated image previews | /var/imgfloat/previews | -| IMGFLOAT_DB_PATH | Filesystem path to the SQLite database file | /var/imgfloat/imgfloat.db | -| IMGFLOAT_INITIAL_TWITCH_USERNAME_SYSADMIN | Twitch username of the initial sysadmin user | example_broadcaster | -| SPRING_SERVLET_MULTIPART_MAX_FILE_SIZE | Maximum upload file size | 10MB | -| SPRING_SERVLET_MULTIPART_MAX_REQUEST_SIZE | Maximum upload request size | 10MB | -| TWITCH_CLIENT_ID | Oauth2 client id | i1bjnh4whieht5kzn307nvu3rn5pqi | -| TWITCH_CLIENT_SECRET | Oauth2 client secret | vpkn8cp7ona65l121j6q78l9gkmed3 | +| `IMGFLOAT_ASSETS_PATH` | Filesystem path to store uploaded assets | /var/imgfloat/assets | +| `IMGFLOAT_PREVIEWS_PATH` | Filesystem path to store generated image previews | /var/imgfloat/previews | +| `IMGFLOAT_DB_PATH` | Filesystem path to the SQLite database file | /var/imgfloat/imgfloat.db | +| `IMGFLOAT_INITIAL_TWITCH_USERNAME_SYSADMIN` | Twitch username of the initial sysadmin user | example_broadcaster | +| `SPRING_SERVLET_MULTIPART_MAX_FILE_SIZE` | Maximum upload file size | 10MB | +| `SPRING_SERVLET_MULTIPART_MAX_REQUEST_SIZE` | Maximum upload request size | 10MB | +| `TWITCH_CLIENT_ID` | Oauth2 client id | i1bjnh4whieht5kzn307nvu3rn5pqi | +| `TWITCH_CLIENT_SECRET` | Oauth2 client secret | vpkn8cp7ona65l121j6q78l9gkmed3 | Optional: | Variable | Description | Example Value | |----------|-------------|---------------| -| TWITCH_REDIRECT_URI | Override default redirect URI | http://localhost:8080/login/oauth2/code/twitch | +| `TWITCH_REDIRECT_URI` | Override default redirect URI | http://localhost:8080/login/oauth2/code/twitch | During development environment variables can be placed in the `.env` file at the project root to automatically load them. Be aware that these are only loaded when using the [Makefile](./Makefile) command `make run`.