Update docs and get ready for the next big update.

PakL · Nov 10, 2017 · debe6e0 · debe6e0
1 parent 8405e6f
commit debe6e0
Show file tree

Hide file tree

Showing 31 changed files with 2,288 additions and 343 deletions.
diff --git a/README.md b/README.md
@@ -10,15 +10,13 @@ To make TTVST unique for your streaming needs it's possible to create your own o
 
 The TTVStreamerTool is developed and tested on an Windows 10 x64 system. I guess everything >= Windows 8 should work.
 
-Linux or MacOS are **not** supported. *You could download the source code and tweak it here and there to make it work though...*
+Linux or MacOS are **not** supported. (And propably never will be.)
 
 ### Download & Install
 
-Download the zip in the v0.1.2 release and unpack it somewhere you don't need elevated writing rights. This is because the auto updater needs to overwrite some files there. You could start the program as an administrator but this is not recommended.
+Download the Setup.exe of the latest release and execute it. The application will install and create a few shortcuts. From then on the application should keep itself updated. Since I don't have the time or money for an code signing certificate the Setup.exe might be blocked from executing. It's up to you to trust this application. Do not install a Setup.exe that was not downloaded from the releases page of this project. Stay safe!
 
-After unpacking start the tool by double clicking the `ttv-streamertool.exe`.
-
-» [Version 0.1.2 release](https://github.com/PakL/TTVStreamerTool/releases/tag/v0.1.2)
+» [Find tha latest release](https://github.com/PakL/TTVStreamerTool/releases/)
 
 ### Screenshot
 

diff --git a/docs/Addons.html b/docs/Addons.html
diff --git a/docs/Channel.html b/docs/Channel.html
diff --git a/docs/Chat.html b/docs/Chat.html
diff --git a/docs/Cockpit.html b/docs/Cockpit.html
diff --git a/docs/Follows.html b/docs/Follows.html
diff --git a/docs/Overlays.html b/docs/Overlays.html
diff --git a/docs/TTVLogin.html b/docs/TTVLogin.html
diff --git a/docs/TTVTool.html b/docs/TTVTool.html
diff --git a/docs/ToolSettings.html b/docs/ToolSettings.html
diff --git a/docs/ToolUI.html b/docs/ToolUI.html
diff --git a/docs/TwitchChat.html b/docs/TwitchChat.html
diff --git a/docs/TwitchTv.html b/docs/TwitchTv.html
diff --git a/docs/UIPage.html b/docs/UIPage.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/lib_addons.js.html b/docs/lib_addons.js.html
diff --git a/docs/lib_auth.js.html b/docs/lib_auth.js.html
diff --git a/docs/lib_chat.js.html b/docs/lib_chat.js.html
diff --git a/docs/lib_cockpit.js.html b/docs/lib_cockpit.js.html
diff --git a/docs/lib_overlay.js.html b/docs/lib_overlay.js.html
diff --git a/docs/lib_settings.js.html b/docs/lib_settings.js.html
diff --git a/docs/mod_tool.js.html b/docs/mod_tool.js.html
diff --git a/docs/mod_toolui.js.html b/docs/mod_toolui.js.html
diff --git a/docs/mod_twitchchat.js.html b/docs/mod_twitchchat.js.html
diff --git a/docs/mod_twitchtv.js.html b/docs/mod_twitchtv.js.html
diff --git a/docs/mod_uipage.js.html b/docs/mod_uipage.js.html
diff --git a/docs/tutorial-Getting Started.html b/docs/tutorial-Getting Started.html
diff --git a/docs/var_channel.js.html b/docs/var_channel.js.html
diff --git a/docs/var_follows.js.html b/docs/var_follows.js.html
diff --git a/lib/settings.js b/lib/settings.js
@@ -60,41 +60,53 @@ class ToolSettings {
 	}
 
 	/**
+	 * Loads and returns weither or not to show follow alerts
+	 * 
 	 * @member {Boolean}
 	 * @readonly
 	 */
 	get showFollowAlert() {
 		return this.getBoolean('showfollowalert', true)
 	}
 	/**
+	 * Loads and returns weither or not to show subscription alerts
+	 * 
 	 * @member {Boolean}
 	 * @readonly
 	 */
 	get showSubscriptionAlert() {
 		return this.getBoolean('showsubscriptionalert', true)
 	}
 	/**
+	 * Loads and returns weither or not to show raid alerts
+	 * 
 	 * @member {Boolean}
 	 * @readonly
 	 */
 	get showRaidAlert() {
 		return this.getBoolean('showraidalert', true)
 	}
 	/**
+	 * Loads and returns weither or not to show host alerts
+	 * 
 	 * @member {Boolean}
 	 * @readonly
 	 */
 	get showHostAlert() {
 		return this.getBoolean('showhostalert', true)
 	}
 	/**
+	 * Loads and returns weither or not to show ban alerts
+	 * 
 	 * @member {Boolean}
 	 * @readonly
 	 */
 	get showBanAlert() {
 		return this.getBoolean('showbanalert', true)
 	}
 	/**
+	 * Loads and returns weither or not to show timeout alerts
+	 * 
 	 * @member {Boolean}
 	 * @readonly
 	 */
@@ -103,6 +115,8 @@ class ToolSettings {
 	}
 
 	/**
+	 * Loads and returns weither or not to show the viewers list
+	 * 
 	 * @member {Boolean}
 	 * @readonly
 	 */
@@ -120,6 +134,12 @@ class ToolSettings {
 		return this.getJSON('highlights', [])
 	}
 
+	/**
+	 * Loads and returns weither or not to invert the application's colors
+	 * 
+	 * @member {Boolean}
+	 * @readonly
+	 */
 	get lightDesignMode() {
 		return this.getBoolean('lightdesignmode', false)
 	}

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "ttv-streamertool",
-	"version": "0.1.7",
+	"version": "0.2.0",
 	"main": "main.js",
 	"description": "TTVST is an application aimed at Twitch streamer.",
 	"author": {