Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

Commit

Permalink
fixes to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
NTMNathan committed Sep 22, 2021
1 parent d6d2c0e commit b4fa1eb
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/JSON.html
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ <h5>Returns:</h5>


<div class="param-desc">
<p>The lyrics and its informtation.</p>
<p>The lyrics and its information.</p>
</div>


Expand Down Expand Up @@ -818,7 +818,7 @@ <h4 class="name" id="textFormat"><span class="type-signature">(async) </span>tex


<div class="description usertext">
<p>Returns a random response.</p>
<p>Formats the provided text into a different style.</p>
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -1263,7 +1263,7 @@ <h5 class="subsection-title">Properties:</h5>

<tr>

<td class="name"><code>scores</code></td>
<td class="name"><code>score</code></td>


<td class="type">
Expand Down
9 changes: 7 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,12 @@ <h2>💾 Installation</h2>
<pre class="prettyprint source lang-bash"><code>npm install weeby-js --save
</code></pre>
<h2>🗝 Authentication</h2>
<p><code>weeby-js</code> requires an authorization token which can be obtained by joining the <a href="https://weebyapi.xyz/discord">NTM Discord Server</a>, and then running the <code>/apply</code> command with the Weeby API bot. To learn more in deep about the application process, please visit the <a href="https://weebyapi.xyz/">Weeby API Website</a>.</p>
<p><code>weeby-js</code> requires an authorization token which can be obtained by doing one of the following methods:</p>
<ul>
<li>Joining the <a href="https://weebyapi.xyz/discord">NTM Central Discord Server</a>, and then running the <code>/apply</code> command with the Weeby API bot.</li>
<li>Logging into the <a href="https://weebyapi.xyz/dashboard">Dashboard</a> and then using the <a href="https://weebyapi.xyz/dashboard/apply">application form</a> and filling in the required fields.</li>
</ul>
<p>To learn more in deep about the application process, please visit the <a href="https://weebyapi.xyz/gettingstarted">Getting Started</a> page.</p>
<blockquote>
<p>Upon being accepted into Weeby API. It is very important to <strong>never</strong> show this token to anybody.</p>
</blockquote>
Expand All @@ -95,7 +100,7 @@ <h3>GIF:</h3>
const weeby = new WeebyAPI(&quot;YOUR_TOKEN&quot;);

let gif = await weeby.gif.fetch(&quot;pat&quot;);
console.log(gif); // -> https://weebyapi.xyz/img/gif/pat/13.gif
console.log(gif); // -> https://cdn.weebyapi.xyz/img/gif/pat/13.gif
</code></pre>
<h3>Generator:</h3>
<pre class="prettyprint source lang-js"><code>const WeebyAPI = require(&quot;weeby-js&quot;);
Expand Down
6 changes: 3 additions & 3 deletions docs/json.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h1 class="page-title">json.js</h1>
}

/**
* 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.
Expand Down Expand Up @@ -160,7 +160,7 @@ <h1 class="page-title">json.js</h1>
/**
* 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&lt;lyricsResponse>} The lyrics and its informtation.
* @returns {Promise&lt;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.")}`);
Expand Down Expand Up @@ -231,7 +231,7 @@ <h1 class="page-title">json.js</h1>
* @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.
*/</code></pre>
Expand Down

0 comments on commit b4fa1eb

Please sign in to comment.