@mkody/twitch-emoticons 2.3.2 → 2.5.0

package/.github/workflows/yarn-test.yml

@@ -9,7 +9,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 12
+          node-version: 16
       - run: yarn
       - run: yarn lint
       - run: yarn test
+        env:
+          TWITCH_ID: ${{ secrets.TWITCH_ID }}
+          TWITCH_SECRET: ${{ secrets.TWITCH_SECRET }}

package/README.md

@@ -1,6 +1,6 @@
 # twitch-emoticons
 
-Get a Twitch channel's Twitch emotes, BTTV emotes, and FFZ emotes!
+Gets Twitch, BTTV and FFZ emotes as well as parsing text to emotes!
 
 ### About this fork's 2.3.0+
 You must now use a Twitch user ID instead of the username to fetch user's emotes.  
@@ -8,12 +8,11 @@ You can use [this page to quickly grab it](https://s.kdy.ch/twitchid/).
 
 _FFZ still supports names, but usage of the ID is recommended._
 
-### Note about Twitch emotes
-We've seen twitchemotes.com's API returning "channel not found" at multiple occasions (as of early May 2021).  
-A fallback system to a static json for the global emotes is in place, but if their service is down or not working you will not be able to fetch the list of emotes from a specific channel.  
-If you have an alternative API or some quick code to get them from Twitch directly, feel free to share in Issue #8.
+### About this fork's 2.4.0+
+You now need to use the official Twitch API to get emotes. For this you need to provide your client id and client secret.
+To get a client and secret create a Twitch app [here](https://dev.twitch.tv/console/apps/create), it's free.
 
-BetterTTV and FrankerFaceZ are still working fine.
+If you are only using BetterTTV and FrankerFaceZ you don't need to provide anything as they are independent from the Twitch API.
 
 ### Install
 ```sh
@@ -27,7 +26,10 @@ yarn add @mkody/twitch-emoticons
 ```js
 const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
 
-const fetcher = new EmoteFetcher();
+const clientId = '<your client id>';
+const clientSecret = '<your client secret>';
+
+const fetcher = new EmoteFetcher(clientId, clientSecret);
 const parser = new EmoteParser(fetcher, {
     type: 'markdown',
     match: /:(.+?):/g
@@ -52,6 +54,5 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 - [Changelog](https://github.com/mkody/twitch-emoticons/releases)
 
 This library uses the following:
-- [Twitch Emotes API](https://twitchemotes.com/apidocs)
 - [BetterTTV API](https://betterttv.com/)
 - [FrankerFaceZ API](http://www.frankerfacez.com/developers)