From b4fa1eb15128a262d26a3ef365db0ddde2f95b64 Mon Sep 17 00:00:00 2001 From: Nate Date: Thu, 23 Sep 2021 00:11:17 +1000 Subject: [PATCH] fixes to docs --- docs/JSON.html | 4 ++-- docs/global.html | 2 +- docs/index.html | 9 +++++++-- docs/json.js.html | 6 +++--- 4 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/JSON.html b/docs/JSON.html index bff3762..db52f4f 100644 --- a/docs/JSON.html +++ b/docs/JSON.html @@ -306,7 +306,7 @@
Returns:
-

The lyrics and its informtation.

+

The lyrics and its information.

@@ -818,7 +818,7 @@

(async) tex
-

Returns a random response.

+

Formats the provided text into a different style.

diff --git a/docs/global.html b/docs/global.html index 6350a7f..6f7eb9d 100644 --- a/docs/global.html +++ b/docs/global.html @@ -1263,7 +1263,7 @@

Properties:
- scores + score diff --git a/docs/index.html b/docs/index.html index 633b0a7..667e49d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -85,7 +85,12 @@

๐Ÿ’พ Installation

npm install weeby-js --save
 

๐Ÿ— Authentication

-

weeby-js requires an authorization token which can be obtained by joining the NTM Discord Server, and then running the /apply command with the Weeby API bot. To learn more in deep about the application process, please visit the Weeby API Website.

+

weeby-js requires an authorization token which can be obtained by doing one of the following methods:

+ +

To learn more in deep about the application process, please visit the Getting Started page.

Upon being accepted into Weeby API. It is very important to never show this token to anybody.

@@ -95,7 +100,7 @@

GIF:

const weeby = new WeebyAPI("YOUR_TOKEN"); let gif = await weeby.gif.fetch("pat"); -console.log(gif); // -> https://weebyapi.xyz/img/gif/pat/13.gif +console.log(gif); // -> https://cdn.weebyapi.xyz/img/gif/pat/13.gif

Generator:

const WeebyAPI = require("weeby-js");
diff --git a/docs/json.js.html b/docs/json.js.html
index 0ae72de..886af63 100644
--- a/docs/json.js.html
+++ b/docs/json.js.html
@@ -131,7 +131,7 @@ 

json.js

} /** - * Returns a random response. + * Formats the provided text into a different style. * @param {Object} options - The options that contain the required parameters. * @param {string} options.type - The type of text formatter. * @param {string} options.text - The text to format. @@ -160,7 +160,7 @@

json.js

/** * Fetches lyrics from the Genius API. * @param {string} query - The lyrics to search. See https://weebyapi.xyz/api/docs#json for all the JSON endpoints. - * @returns {Promise<lyricsResponse>} The lyrics and its informtation. + * @returns {Promise<lyricsResponse>} The lyrics and its information. */ async lyrics(query) { if (typeof query !== "string") throw new Error(`${chalk.magenta("Weeby-JS")} ${chalk.gray("ยป")} ${chalk.yellow("The Query parameter is not a string.")}`); @@ -231,7 +231,7 @@

json.js

* @prop {String} title - The title of the post. * @prop {String} author - The author of the post. * @prop {String} date - The date the post was created. -* @prop {Number} scores - The number of scores the post earned. +* @prop {Number} score - The number of scores the post earned. * @prop {Number} comments - The number of comments on the post. * @prop {Number} awards - The number of awards given on the post. */