Skip to content

Commit

Permalink
Update README to include install/usage instructions (#43)
Browse files Browse the repository at this point in the history
* Remove example text from Extension Settings

* Add Getting Started instructions

- Add OAuth token to Requirements as you can't use the extension without it

* Add Twitch Commands
  • Loading branch information
Fletcher authored and clarkio committed Feb 2, 2019
1 parent b28e504 commit 4bed01b
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <LineNumber> OR !line <LineNumber>
To unhighlight a line, use:

!line !<LineNumber>

## Extension Settings

- `twitchhighlighter.channels`: The channel name(s) to connect to on Twitch.

Expand Down

0 comments on commit 4bed01b

Please sign in to comment.