diff --git a/README.md b/README.md index 4af5571..3fc6529 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ yttui === -This is a TUI tool to monitor YouTube channels for new videos and keep track of which ones you've watched already. +This is a TUI tool to monitor YouTube channels for new videos and keep track of which ones you've already watched. This tool is work in progress and some functions might not work (correctly). ### Building @@ -39,7 +39,7 @@ This tool is work in progress and some functions might not work (correctly). |Option | Description | Default value | Required | |-------|-------------|---------------|--------- | | apiKey | YouTube API Key | | ✓ | -| extraHeaders | Extra HTTP headers to send to YouTube. This is a JSON array of objects containing `"key"` and `"value"`. Will be sent with each API requres. | `[]` | ✘ | +| extraHeaders | Extra HTTP headers to send to YouTube. This is a JSON array of objects containing `"key"` and `"value"`. Will be sent with each API requrest. | `[]` | ✘ | | database | Path of channel/video database | $HOME/.local/share/yttui.db | ✘ | | watchCommand | Command executed to watch a video. `{{vid}}` will be replaced by the Id of the video to watch. | `["xdg-open", "https://youtube.com/watch?v={{vid}}"]` | ✘ | | notifications | Object describing notification settings | `{}` | ✘ |