60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
<h1 align="center"> CATH </h1>
|
|
|
|
<!-- header -->
|
|
<p align="center">
|
|
<img src = "https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415">
|
|
<br>
|
|
<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>
|
|
<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>
|
|
</p>
|
|
|
|
**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>
|
|
|
|
# Install the package ✔
|
|
|
|
Download from npm
|
|
|
|
```powershell
|
|
npm install cath
|
|
```
|
|
|
|
Download from yarn
|
|
|
|
```powershell
|
|
yarn add cath
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Launch of the module
|
|
|
|
```js
|
|
const cath = require("cath");
|
|
|
|
const reddit_data = await cath.getreddit("meme");
|
|
console.log(reddit_data); // returns an object
|
|
|
|
const answer = await cath.random8ball();
|
|
console.log(answer); // a random answer from 8ball
|
|
```
|
|
|
|
# License
|
|
|
|
NullValkyrie is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/NullValkyrie/blob/master/LICENSE) for more information.
|
|
|
|
# Support, Feature Request & Bug Reports
|
|
|
|
## <img src = "https://cdn.discordapp.com/emojis/867093614403256350.png?v=1" width = 18> Support & Feature Request
|
|
|
|
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/867093601962950666.png?v=1" width = "18"> Report Bugs
|
|
|
|
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 align = "center">
|
|
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
|
|
</p>
|