commit 8199c90bd7be9abcb25d3d45906eb78bd7169474 parent 20e233bab8e1e7b6824facb5788ef63c981f2e90 Author: underd0g1 <firstname.lastname@example.org> Date: Thu, 2 Jul 2020 23:57:42 -0400 added readme.md Diffstat:
1 file changed, 42 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,42 @@ +# Buddy +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![npm version](https://badge.fury.io/js/node-fetch.svg)](https://badge.fury.io/js/node-fetch) +[![Maintainability](https://api.codeclimate.com/v1/badges/a3a91ff9c00a800c5850/maintainability)](https://codeclimate.com/github/underd0g1/buddy/maintainability) +[![HitCount](http://hits.dwyl.io/underd0g1/buddy.svg)](http://hits.dwyl.io/underd0g1/buddy) + +## Buddy is a simple yet fun and interactive node.js bot for Discord. + +## Requirements + +- node.js version 10 or higher +- Npm 4.x.x or higher +- Current Discord account with at least one server (guild) +- Current Discord Dev account + + +## Installation + +- Install node.js +- meet dependency Requirements +- clone the buddy repository +- navigate to directory +- edit the .js file and insert your ID numbers into the corresponding places + +` $ node buddy1.js ` +## Usage +After Adding buddy to the server, you may insteract with him in a number of ways. +His command syntax is ' $ ![command] ' + +Here are a list of commands that buddy will respond to: + + - code + - iss + - beer + - multiply x y + - help + + (You may also invoke the help command in the server to get a list of commands) + +## Notes + +> Buddy was designed as just a cool bot to play around with in the discord server. Fork this repo or make a pull request to help me make him cooler. If you want to repurpose buddy for your own needs, please clone and do so! To change his features, just edit the .js file. Make sure to restart node every time that you make a change!