From f88beddf1199088d5fc262d5f1d7690adb1372ac Mon Sep 17 00:00:00 2001 From: night0721 Date: Tue, 14 Sep 2021 20:01:30 +0800 Subject: [PATCH] readme --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/README.md b/README.md index 31d7896..21ebc4d 100644 --- a/README.md +++ b/README.md @@ -1 +1,56 @@ + + + # Cath + +[![NPM](https://nodei.co/npm/cath.png)](https://npmjs.org/package/cath) + +[![Package](https://img.shields.io/github/package-json/v/night0721/cath?color=02023a&style=for-the-badge)](https://npmjs.org/package/cath) +[![License](https://img.shields.io/npm/l/cath?color=02023a&style=for-the-badge)](https://npmjs.org/package/cath) +[![Downloads](https://img.shields.io/npm/dw/cath?color=02023a&style=for-the-badge)](https://npmjs.org/package/cath) +[![Support Server](https://img.shields.io/discord/718762019586572341?label=Support%20Server&logo=Discord&colorB=5865F2&style=for-the-badge&logoColor=white) ](https://discord.gg/SR7TeNJG67) +![Repo Stars](https://img.shields.io/github/stars/night0721/cath?logo=github&color=5865F2&style=for-the-badge) + +**cath** is a powerful [Node.js](https://nodejs.org) module that can easily interact and get data from the Cath API +If you like this package, feel free to **Star** and **fork** this repository.

+ +# Install the package ✔ + +Download from npm + +```cli +npm install cath +``` + +Download from yarn + +```cli +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 +``` + +# Support, Feature Request & Bug Reports + +## Support & Feature Request + +Join the official [Support Server](https://discord.gg/SbQHChmGcp) on Discord & we will be happy to assist you.
+To Request new features contact us on Discord using the support server. + +## 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. + +[![Support Server](https://img.shields.io/discord/718762019586572341?label=Support%20Server&logo=Discord&colorB=5865F2&style=for-the-badge&logoColor=white) ](https://discord.gg/SR7TeNJG67)