hubot-twitch - npm Package Compare versions

Comparing version 1.0.1 to 1.1.1

package.json

 {
   "name": "hubot-twitch",
   "description": "A Hubot script for interacting with Twitch.tv API.",
-  "version": "1.0.1",
+  "version": "1.1.1",
 
@@ -6,0 +6,0 @@ "author": "Ian Lai <[e-mail]>",

README.md

@@ -8,3 +8,3 @@ # Hubot: Twitch.tv
 
-1. Install the __hubot-twitch__ module as a Hubot dependency by adding it to your `package.json` file:
+1. Install the __hubot-twitch__ module as a Hubot dependency by running:
 
@@ -18,13 +18,17 @@ ```
     ```json
-    ["hubot-twitch"]
+    [
+        "hubot-twitch"
+    ]
     ```
 
-3. Run `npm install`
+3. Run your bot and see below for available config / commands
 
 
-## Config
+## Configuration
 
-- `TWITCH_API_KEY`
-- `HUBOT_TWITCH_KEY`
-- `HUBOT_TWITCH_MAX_RESULTS` _(TBA)_
+Variable | Default | Description
+--- | --- | ---
+`TWITCH_API_KEY` | N/A | _(Optional)_ To avoid any restrictions when using Twitch API, please [register your application](http://www.twitch.tv/settings/connections) and set your application [client ID](https://github.com/justintv/Twitch-API/blob/master/authentication.md#developer-setup) using this config
+`TWITCH_MAX_RESULTS` | 5 | The maximum number of result(s) to return
+`TWITCH_STORAGE_KEY` | _twitch | The unique key used for persistence (storing/retrieving users' Twitch-related data from memory)
 
@@ -36,8 +40,8 @@
 --- | ---
-hubot ttv follows | Returns the 10 most recent live streams belonging to your followed channels (list populated from your linked Twitch user)
+hubot ttv follows | Returns the 10 most recent live streams belonging to your followed channels (list populated from your linked Twitch user, see command below)
 hubot ttv link `user` | Link Twitch `user` to you
-hubot ttv featured | Returns the first 5 featured live streams
-hubot ttv game `category` | Returns the first 5 live streams in a game `category` (case-sensitive)
-hubot ttv search `query` | Returns the first 5 live streams matching the search `query`
+hubot ttv featured | Returns the first `TWITCH_MAX_RESULTS` (or 5) featured live streams
+hubot ttv game `category` | Returns the first `TWITCH_MAX_RESULTS` (or 5) live streams in a game `category` (case-sensitive)
+hubot ttv search `query` | Returns the first `TWITCH_MAX_RESULTS` (or 5) live streams matching the search `query`
 hubot ttv stream `name` | Returns information about stream `name`
-hubot ttv top | Returns the top 5 games sorted by the number of current viewers on Twitch, most popular first
+hubot ttv top | Returns the top `TWITCH_MAX_RESULTS` (or 5) games sorted by the number of current viewers on Twitch, most popular first

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14955

increased by5.86%

Number of lines in readme file

44

increased by10%

No dependency changes