diff --git a/README.md b/README.md index 2797a88..e686fa9 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,36 @@ Some of the code in this extension has been adapted from the [twitchlint extensi - A Twitch account ([sign up here](https://www.twitch.tv/signup)) - Register an application [here](https://glass.twitch.tv/console/apps/create) +- An OAuth token which you can generate [here](http://twitchapps.com/tmi/) - [VS Code](https://code.visualstudio.com) -## Extension Settings +## Getting Started + +From the Command Palette: +1. Run `Twitch Highlighter: Set Client Id` +2. Paste the Client ID from your application +3. Run `Twitch Highlighter: Set Password` +4. Paste your generated OAuth token with the 'OAuth:' in front + +Outside of the Command Palette: + +5. Set `twitchhighlighter.channels` to your channel in User/Workspace Settings + + "twitchhighlighter.channels": ["clarkio"] -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. +6. Hit `Disconnected` at the bottom right of VS Code to connect -For example: +## Twitch Commands -This extension contributes the following settings: +To highlight a line, use: + + !highlight OR !line + +To unhighlight a line, use: + + !line ! + +## Extension Settings - `twitchhighlighter.channels`: The channel name(s) to connect to on Twitch.