embee/woomy
1
2
Fork 2
Code Issues Pull requests Projects Releases Wiki Activity

Made readme friendlier

Browse source
This commit is contained in:
Emily 2020-03-24 09:05:32 +00:00 committed by GitHub
parent 51e307b3d6
commit 7fdeceee67
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,16 +1,16 @@
# Woomy # Woomy
Woomy is a all-purpose discord bot built off the [guidebot](https://github.com/AnIdiotsGuide/guidebot) base and coded in node.js using discord.js. Woomy is a all-purpose discord bot built off the [guidebot](https://github.com/AnIdiotsGuide/guidebot) base and coded in node.js using discord.js.
# How to use # How to use
The easiest way to use Woomy is to invite it to your server with [this link.](https://discordapp.com/oauth2/authorize?client_id=435961704145485835&permissions=2134240503&scope=bot) It is hosted 24/7 and automatically updates itself when a new release is made available, making sure you always get the newest features. The easiest way to use Woomy is to invite it to your server with [this link.](https://discordapp.com/oauth2/authorize?client_id=435961704145485835&permissions=2134240503&scope=bot) It is hosted 24/7 and automatically updates itself when a new release is made available, making sure you always get the newest features.
Self hosting is generally not recommended, but instructions are provided below if you still wish to do so. Woomy's code will need to be modified before it will run on your machine. You can also self-host! Some modificatiomns to the code will need to be made before Woomy will run on your machine, but anyone who can read errors will figure out what needs to be changed pretty quickly :P
# Requirements # Requirements
- git - git
- node.js v12.0.0 or higher - node.js v12.0.0 or higher
- node-gyp build tools - node-gyp build tools
- ffmpeg - ffmpeg (or ffmpeg-static)
# Installation # Installation
- Clone Woomy to your machine - Clone Woomy to your machine
@ -18,4 +18,4 @@ Self hosting is generally not recommended, but instructions are provided below i
- Open config.js in your code editor and insert all the required information - Open config.js in your code editor and insert all the required information
# Contributing # Contributing
If you wish to contribute to Woomy, please fork the repository and open a pull request. If you wish to contribute to Woomy, please fork the repository and open a pull request. Any contribution is appreciated <3