Update configuration section of readme

README.md

@@ -10,7 +10,7 @@ Think of Streamwall as a specialized web browser for mosaicing video streams. It
 
 ## Installation
 
-Download and install the latest release from the [Releases page](https://github.com/streamwall/streamwall/releases).
+Download and install the latest release for your system from the [Releases page](https://github.com/streamwall/streamwall/releases).
 
 ## Running Streamwall
 
@@ -24,8 +24,40 @@ Download and install the latest release from the [Releases page](https://github.
 
 Streamwall has a number of configuration options. See `example.config.toml` for an example.
 
-TODO: Document all available options.
-TODO: Document how to use the config file.
+| Option | Description | Default | Example | Accepted Values |
+|--------|-------------|---------|---------|-----------------|
+| `cert.dir` | The directory to store SSL certificates for HTTPS | Not set | `"./certs"` | Any valid directory path |
+| `cert.email` | The email address for the SSL certificate owner | Not set | `"admin@example.com"` | Any valid email address |
+| `cert.production` | Whether to obtain a real SSL certificate (true) or use a test one (false) | `false` | `true` | `true` or `false` |
+| `control.address` | The full URL where the control panel will be accessible | `"http://localhost:80"` | `"https://myapp.com"` | Any valid URL |
+| `control.hostname` | Override the hostname for the control panel (use with `control.port`) | Not set | `"localhost"` | Any valid hostname |
+| `control.open` | Automatically open the control website in a browser after launching | `true` | `false` | `true` or `false` |
+| `control.password` | The password required to access the control panel | Not set | `"securepass123"` | Any string |
+| `control.port` | Override the port for the control panel (use with `control.hostname`) | Not set | `8080` | Any valid port number |
+| `control.username` | The username required to access the control panel | Not set | `"admin"` | Any string |
+| `data.interval` | The interval in seconds to refresh polled data sources | `30` | `60` | Any positive integer |
+| `data.json-url` | A list of JSON API URLs to load stream sources from | `[]` | `["https://api.example.com/streams"]` | Any list of valid URLs |
+| `data.toml-file` | A list of local TOML files to load stream sources from | `[]` | `["./streams.toml"]` | Any list of valid file paths |
+| `grid.count` | The number of grid cells to display in the window | `3` | `4` | Any positive integer |
+| `streamdelay.endpoint` | The URL of the Streamdelay service endpoint | `"http://localhost:8404"` | `"https://delay.myapp.com"` | Any valid URL |
+| `streamdelay.key` | The API key for authenticating with the Streamdelay service | Not set | `"abc123xyz789"` | Any string |
+| `telemetry.sentry` | Enable or disable error reporting to Sentry | `true` | `false` | `true` or `false` |
+| `twitch.announce.delay` | Time to wait (in seconds) before announcing stream details | `30` | `15` | Any positive integer |
+| `twitch.announce.interval` | Minimum time (in seconds) between re-announcing the same stream | `60` | `120` | Any positive integer |
+| `twitch.announce.template` | The message template for stream announcements in chat | See code | `"Now streaming: <%- stream.title %>"` | Any valid template string |
+| `twitch.channel` | The Twitch channel to connect to for chat interactions | Not set | `"mychannel"` | Any valid Twitch channel name |
+| `twitch.color` | The color of the Twitch bot's username in chat | `"#ff0000"` | `"#00ff00"` | Any valid CSS color value |
+| `twitch.password` | The OAuth token for the Twitch bot account | Not set | `"oauth:abc123..."` | Valid Twitch OAuth token |
+| `twitch.username` | The Twitch username for the bot account | Not set | `"mybot"` | Any valid Twitch username |
+| `twitch.vote.interval` | Time interval (in seconds) between votes (0 to disable voting) | `0` | `300` | Any non-negative integer |
+| `twitch.vote.template` | The message template for vote result announcements | See code | `"Stream <%- selectedIdx %> won with <%- voteCount %> votes!"` | Any valid template string |
+| `window.active-color` | The highlight color for active elements in the window | `"#fff"` | `"#ff0000"` | Any valid CSS color value |
+| `window.background-color` | The background color of the window, useful for chroma-keying | `"#000"` | `"#00ff00"` | Any valid CSS color value |
+| `window.frameless` | Creates a window without borders or title bar if set to true | `false` | `true` | `true` or `false` |
+| `window.height` | The height of the application window in pixels | `1080` | `720` | Any positive integer |
+| `window.width` | The width of the application window in pixels | `1920` | `1280` | Any positive integer |
+| `window.x` | The x-coordinate of the window position on the screen | Not set | `100` | Any integer |
+| `window.y` | The y-coordinate of the window position on the screen | Not set | `50` | Any integer |
 
 ## Data sources
 
@@ -56,6 +88,49 @@ Streamwall in its default settings needs enough screen space to display a 1920x1
 
 TODO: Document how to configure the window size.
 
+## Development
+
+### Getting started
+
+1. Clone the repository
+1. Install dependencies with `npm install`
+1. Run the app with `npm start`
+
+### Building
+
+1. Run `npm run build` to build the app for your current platform
+1. The built app will be in the `dist` directory
+
+### Testing
+
+1. Run `npm test` to run the test suite
+1. Please also manually test the app after making changes
+
+### Contributing
+
+1. Fork the repository
+1. Create a new branch
+1. Make your changes
+1. Run the test suite
+1. Create a pull request
+
+### Versioning
+
+Streamwall uses [Semantic Versioning](https://semver.org/).
+
+To release a new version:
+
+1. Update the version number in `package.json`
+1. Run `npm run publish` to create new distributables
+1. Create a new release on GitHub with the new version number
+
 ## Credits
 
-SVG Icons are from Font Awesome by Dave Gandy - http://fontawesome.io
+### Contributors
+
+- @chromakode - Original author & primary maintainer
+- @sayhiben - Current maintainer
+
+### Libraries & Resources
+
+- SVG Icons are from Font Awesome by Dave Gandy - http://fontawesome.io