v3.0.0

Author: The-Clockmaker

CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="3.0.0"></a>
+# [3.0.0](https://github.com/supportclass/lfg-nucleus/compare/v2.0.1...v3.0.0) (2017-03-02)
+
+
+### Features
+
+* **siphon:** update `lfg-siphon` integration to `v0.5.x`
+* add support for Cheers via `lfg-siphon` (#1) ([d86e8cd](https://github.com/supportclass/lfg-nucleus/commit/d86e8cd))
+
+### BREAKING CHANGES
+
+* No longer compatible with `lfg-siphon` < `v0.5.0`
+
+
+
 <a name="2.0.2"></a>
 ## [2.0.2](https://github.com/supportclass/lfg-nucleus/compare/v2.0.1...v2.0.2) (2017-02-02)
 

README.md

@@ -1,29 +1,33 @@
 # lfg-nucleus [![Build Status](https://travis-ci.org/SupportClass/lfg-nucleus.svg?branch=master)](https://travis-ci.org/SupportClass/lfg-nucleus)
 > Meta bundle that ties together functionality from other "lfg" helper bundles.
 
-<img src="screenshot.png"/>
+![screenshot](screenshot.png)
 
 lfg-nucleus is useful for normalizing and centrally managing events from multiple other bundles. 
 At this time, lfg-nucleus integrates with:
 - [lfg-hypetrain](https://github.com/SupportClass/lfg-hypetrain)
-- [lfg-siphon](https://github.com/SupportClass/lfg-siphon)@~0.3.0
-- [lfg-streamtip](https://github.com/SupportClass/lfg-streamtip)@~0.0.1
-- [lfg-sublistener](https://github.com/SupportClass/lfg-sublistener)@^2.0.0
+- [lfg-siphon](https://github.com/SupportClass/lfg-siphon)@~0.5.0
+- [lfg-streamtip](https://github.com/SupportClass/lfg-streamtip)@~1.0.0
+- [lfg-sublistener](https://github.com/SupportClass/lfg-sublistener)@^3.0.0
 
 lfg-nucleus depends on:
- - [lfg-filter](https://github.com/SupportClass/lfg-filter)@^2.0.0
+ - [lfg-filter](https://github.com/SupportClass/lfg-filter)@^3.0.0
 
 ## Using in your bundle
 
-lfg-nucleus emits two events: `subscription` and `tip`.
+lfg-nucleus emits three events: `subscription`, `cheer`, and `tip`.
 
 ### In a graphic or dashboard panel
 ```js
-nodecg.listenFor('subscription', 'lfg-nucleus', function (subscription) {
+nodecg.listenFor('subscription', 'lfg-nucleus', subscription => {
     // do work
 });
 
-nodecg.listenFor('tip', 'lfg-nucleus', function (tip) {
+nodecg.listenFor('cheer', 'lfg-nucleus', cheer => {
+    // do work
+});
+
+nodecg.listenFor('tip', 'lfg-nucleus', tip => {
     // do work
 });
 ```
@@ -35,11 +39,15 @@ Then, create code like the following:
 ```js
 module.exports = function (nodecg) {
     const nucleus = nodecg.extensions['lfg-nucleus'];
-    
+
     nucleus.on('subscription', subscription => {
         // do work
     });
-    
+
+    nucleus.on('cheer', subscription => {
+		// do work
+	});
+
     nucleus.on('tip', tip => {
         // do work
     });
@@ -78,14 +86,14 @@ module.exports = function (nodecg) {
     "timestamp": 1456809533513,
     "id": "8f2ea9cb-2e8f-45dd-8645-0b724b2774f6",
     "read": false,
-    "type": "tip",
-    "amount": 5,
-    "currency": "$",
-    "formattedAmount": "$5",
+    "type": "cheer",
+    "amount": 1000,
+    "formattedAmount": "1,000",
     "comment": "Hi streamer!",
     "email": "[email protected]",
+    "profileUrl": "https://twitch.tv/langeh",
 
-    // Will be "daily" or "monthly" if this tip is the top tip of the day or month.
+    // Will be "daily" or "monthly" if this tip is the top cheer of the day or month.
     "top": null
 }
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lfg-nucleus",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "dependencies": {
     "clone": "^1.0.2",
     "numeral": "^1.5.3",