Skip to content

Commit 2a58144

Browse files
committed
Update README
1 parent 1ee20cf commit 2a58144

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Unity Twitch Chat
22

3-
This is a lightweight and efficient [Twitch.tv IRC](https://dev.twitch.tv/docs/irc/) client for Unity.<br>The primary goal is to be able to read and send chat messages as efficiently as possible.
3+
This is a lightweight and efficient [Twitch.tv IRC](https://dev.twitch.tv/docs/irc/) client for Unity.
4+
5+
In short, this allows you to integrate Twitch Chat to your Unity projects.<br>The primary goal is to be able to read and send chat messages as efficiently as possible.
6+
47

5-
In short, this allows you to integrate Twitch Chat to your Unity projects.
68

79
## Chat message example
810
<img src="https://user-images.githubusercontent.com/18125997/210407885-b2c49e1e-4537-41e9-ad5b-2d8c4c8f1077.png">
@@ -25,7 +27,7 @@ In short, this allows you to integrate Twitch Chat to your Unity projects.
2527

2628
## Installation
2729

28-
- Open Unity Package Manager (Window -> Package Manager)
30+
- Open Unity Package Manager <i>(Window -> Package Manager)</i>
2931
- Click the `+` button in the top left corner
3032
- Select `Add package from git URL...`
3133
- Copy and paste the following URL:<br>
@@ -37,7 +39,7 @@ https://github.com/lexonegit/Unity-Twitch-Chat.git?path=/Unity-Twitch-Chat/Asset
3739

3840
## Quick start
3941
1. Install the Unity package (see above)
40-
2. Create a new empty GameObject and add the TwitchIRC component.
42+
2. Create a new empty GameObject and add the `Twitch IRC` component.
4143
3. In the inspector, set your Twitch authentication details (OAuth, username, channel)
4244
You can generate an OAuth token at https://twitchapps.com/tmi/
4345
OAuth and username are not needed if `Use Anonymous Login` is enabled.

0 commit comments

Comments
 (0)