From 6f2542774835c000f925f540111415c8ddc077e6 Mon Sep 17 00:00:00 2001 From: Abheek Dhawan Date: Fri, 9 Apr 2021 18:21:02 -0500 Subject: [PATCH] Add content to README.md --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 47b773a..33d398e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # AwesomeMod -## More info coming soon! +## About +AwesomeMod is a Discord bot that specializes in moderation. It provides neat and rich logs as well as the ability for users to request roles. Additionally, it has the ability to add a voice channel that's named the amount of members, as Discord makes it difficult to keep track of how many members are in your server. The best part - features can be requested whenever and will be viewed and approved as soon as possible! + +## Installation +Currently there's only one way to install the bot on your server - cloning this repository and running it with node. In the future, I plan to add Docker and NPM as viable ways to deploy the bot. As of now, however, follow these steps for installation: + +1. Clone repo: +``` +git clone https://github.com/ADawesomeguy/AwesomeMod.git +``` +2. Enter repo and install dependencies +``` +cd AwesomeMod && npm i +``` +3. Run the bot: +``` +npm run prod +``` + +## Notes +### Creating a Discord Application/Bot +To create your own application and bot using the [Discord Developer Portal](https://discord.com/developers), go to the previous link and sign in. Then create a new application, and click bots on the left. Configure it to your liking, and then copy the token. + + ![](https://raw.githubusercontent.com/ADawesomeguy/AwesomeSciBo/master/images/discord-developer.png) + +That's the most important part of your bot *and don't share it with anyone*. + +## Credit +The bot was made by [@ADawesomeguy](https://github.com/ADawesomeguy). It is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0.html)