Merge pull request #3 from freesoft/develop

update README

Author: freesoft

README.md

@@ -14,11 +14,12 @@ Both web chat and Twitch TV chatbot are implemented for Detox testing. ( Don't e
 
 Precision/Recall/F1-Score : Shuffled the training set and took 20% of it as comparsion using scikit-learn's classification_report, and here is the result. The data can vary slightly every time and also depends on what kind of dataset is used for training.
 
+
 |     | precision | recall | f1-score | support |
-|-----------------------------------------------|
-|   0 |  0.94     | 1.00   |  0.97    | 28629   |
-|   1 |  0.95     | 0.48   |  0.64    | 3286    |
-|avg/total|  0.94     | 0.94   |  0.94    | 31915  |
+-----|-----------|--------|----------|----------
+   0 |  0.94     | 1.00   |  0.97    | 28629   
+   1 |  0.95     | 0.48   |  0.64    | 3286    
+avg/total|  0.94     | 0.94   |  0.94    | 31915  
 
 
 ### Initialization process
@@ -47,7 +48,7 @@ A few customizations are done here.<br/>
 
 ## Quick startup & test by web chat 
 
-The Detox and its webchat app is deployed on Heroku. (https://uiuc-cs410-detox.herokuapp.com)[https://uiuc-cs410-detox.herokuapp.com] <br/>
+The Detox and its webchat app is deployed on Heroku. [https://uiuc-cs410-detox.herokuapp.com](https://uiuc-cs410-detox.herokuapp.com) <br/>
 Just open the url from your web browser, and try chat. It's ugly webchat but actually functioning for multi chat. Try open a few more tab on your browser and see how toxic classifier works. For any toxic chat that Detox recoginze, the messsage will be displayed in red with "toxic" prefix. **Recommended** if you only need to test how the classifier works.
 
 ![diagram 2](/diagram/overview_chat.png)
@@ -78,7 +79,7 @@ One possible problem is, the Detox requires lots of memory during the training a
 
 ### 2. Use pre-built Docker image
 
-Just in case you have a problem with building the docker image in your local, you can download pre-built image from (here)[https://hub.docker.com/r/freesoft/uiuc-cs410-fall2018].<br/>
+Just in case you have a problem with building the docker image in your local, you can download pre-built image from [here](https://hub.docker.com/r/freesoft/uiuc-cs410-fall2018).<br/>
 To pull the image, run
 
 ```
@@ -116,7 +117,7 @@ It will also create a file with same channel name that Chatbox connected(`<chann
 Parameter explanation:
 
 * `<username>` : Your username on Twitch. 
-* `<client id>` : visit https://glass.twitch.tv/ and login with your own Twitch account. Once you create new app, you'll be able to get Client ID on Dashboard -> App section. <br/>
+* `<client id>` : visit [https://glass.twitch.tv/](https://glass.twitch.tv/) and login with your own Twitch account. Once you create new app, you'll be able to get Client ID on Dashboard -> App section. <br/>
 * `<oauth2 access token>` : visit [here](https://twitchapps.com/tmi/#access_token=flwh72scl6503e6bs2xnwl6g6l5jeu&scope=chat%3Aread+chat%3Aedit+channel%3Amoderate+chat_login&token_type=bearer) and click "Connec with Twitch", and use it for `<oauth2 access token>`.
 * `<channel name>` : TwitchTV channel name you'd like to deploy Moira. Use the channel name you can check from web browser's url, which is generally all lowercase regardless of what you can see on twitch user's dashboard.
 
@@ -137,4 +138,4 @@ First line should start with following header title,
 and from 2nd line you can use your own data. The engine doesn't care much about the value in the "id" part and add whatever chat logs you'd like to test.
 
 Training data file has similar format, but it has additional CSV column that needs to be pre-labeled by human so that it can be used for traning purpose.
- 
+