From 23db26ad67566fd8a4afe6362cc9aefa87b8ed90 Mon Sep 17 00:00:00 2001 From: Gweep Creative <69747065+GweepCreative@users.noreply.github.com> Date: Sat, 11 Nov 2023 17:26:23 +0300 Subject: [PATCH] Update readme.md getGameById and getGameByName added --- readme.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/readme.md b/readme.md index 11ce5b5..eae9ad8 100644 --- a/readme.md +++ b/readme.md @@ -106,6 +106,72 @@ console.log(clip) } ``` +## getGameByName(game_name) +> Paramaters +- game_name(string): Twitch game name + +> Response +- Game Data + +### Example Usage +```js +import Twitcher from "twitcher" +let client = new Twitcher({ + token:"YOUR TOKEN", + client_id:"YOUR CLIENT ID", +}) +let game = await client.getGameByName("Fortnite") +console.log(game) +``` + +### Example Response +```js +{ + success: true, + data: [ + { + id: '33214', + name: 'Fortnite', + box_art_url: 'https://static-cdn.jtvnw.net/ttv-boxart/33214-{width}x{height}.jpg', + igdb_id: '1905' + } + ] +} +``` + +## getGameById(game_id) +> Paramaters +- game_id(Number): Twitch game id + +> Response +- Game Data + +### Example Usage +```js +import Twitcher from "twitcher" +let client = new Twitcher({ + token:"YOUR TOKEN", + client_id:"YOUR CLIENT ID", +}) +let game = await client.getGameById("509658") +console.log(game) +``` + +### Example Response +```js +{ + success: true, + data: [ + { + id: '509658', + name: 'Just Chatting', + box_art_url: 'https://static-cdn.jtvnw.net/ttv-boxart/509658-{width}x{height}.jpg', + igdb_id: '' + } + ] +} +``` + ## searchChannel(query) > Paramaters - query: Twitch channel name