This commit is contained in:
night0721 2023-11-02 00:59:15 +00:00
parent b864d53b22
commit b059f4313c

115
README.md
View file

@ -1,59 +1,56 @@
<h1 align="center"> CATH </h1> # Cath
<!-- header --> [![Banner](https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415)]()
<p align="center"> [![Version](https://img.shields.io/github/package-json/v/night0721/cath?style=for-the-badge&color=555555&labelColor=02023a)]()
<img src = "https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415"> [![Download](https://img.shields.io/npm/dt/cath?style=for-the-badge&color=02023a)]()
<br> [![Kofi](https://img.shields.io/static/v1?label=Support%20Us&message=KO.FI&color=ff5e5b&logo=kofi&logoColor=white&style=for-the-badge&scale=1.4)]()
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Version' src="https://img.shields.io/github/package-json/v/night0721/cath?style=for-the-badge&color=555555&labelColor=02023a"></a>
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Download' src="https://img.shields.io/npm/dt/cath?style=for-the-badge&color=02023a"></a> **Cath** is a powerful [npm](https://nodejs.org) module that can easily interact and get data from NYX API
<a href="https://ko-fi.com/I2I35XISJ" target="_blank"><img alt='Kofi' src="https://img.shields.io/static/v1?label=Support%20Us&message=KO.FI&color=ff5e5b&logo=kofi&logoColor=white&style=for-the-badge&scale=1.4"></a> If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> **Star** and **fork** this repository.<br><br>
</p>
# Install the package ✔
**Cath** is a powerful [npm](https://nodejs.org) module that can easily interact and get data from NYX API
If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> **Star** and **fork** this repository.<br><br> Download from npm
# Install the package ✔ ```powershell
npm install cath
Download from npm ```
```powershell Download from yarn
npm install cath
``` ```powershell
yarn add cath
Download from yarn ```
```powershell ## Examples
yarn add cath
``` ### Launch of the module
## Examples ```js
const cath = require("cath")l
### Launch of the module const redditdata = await cath.getreddit("meme");
console.log(redditdata); // returns a object
```js
const cath = require("cath")l const answer = await cath.random8ball();
const redditdata = await cath.getreddit("meme"); console.log(answer); // a random answer from 8ball
console.log(redditdata); // returns a object ```
const answer = await cath.random8ball(); # License
console.log(answer); // a random answer from 8ball
``` NullValkyrie is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/cath/blob/master/LICENSE) for more information.
# License # Support, Feature Request & Bug Reports
NullValkyrie is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/cath/blob/master/LICENSE) for more information. ## <img src = "https://cdn.discordapp.com/emojis/867093614403256350.png?v=1" width = 18> Support & Feature Request
# Support, Feature Request & Bug Reports Join the official [Support Server](https://discord.gg/SbQHChmGcp) on Discord & we will be happy to assist you. <br>
To Request new features contact us on Discord using the support server.
## <img src = "https://cdn.discordapp.com/emojis/867093614403256350.png?v=1" width = 18> Support & Feature Request
## <img src = "https://cdn.discordapp.com/emojis/867093601962950666.png?v=1" width = "18"> Report Bugs
Join the official [Support Server](https://discord.gg/SbQHChmGcp) on Discord & we will be happy to assist you. <br>
To Request new features contact us on Discord using the support server. You can report bugs or issues by opening a issue in this repository. Alternatevely you can also contact us on Discord using the support server.
## <img src = "https://cdn.discordapp.com/emojis/867093601962950666.png?v=1" width = "18"> Report Bugs <p align = "center">
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
You can report bugs or issues by opening a issue in this repository. Alternatevely you can also contact us on Discord using the support server. </p>
<p align = "center">
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
</p>