grunt

README

Grunt - Discord Bot

You can invite the bot to your server using this link

Want to contribute to the bot in some way? Read the CONTRIB.md file

---

Table of contents

• The Pitch
• Commands
• Run It Yourself
• Credit And Thanks

---

The Pitch

DESCRIPTION OF YOUR BOT: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sit amet consequat magna. Nam malesuada vitae tortor id aliquam. Praesent congue lectus quis neque scelerisque euismod. Pellentesque malesuada diam ut purus facilisis, et ultricies tellus vulputate. Sed a consequat ipsum. Vivamus dui neque, venenatis non dui vitae, mattis pulvinar nisl. Praesent vitae viverra mi.

---

Commands

All the commands start with the prefix /

Name	Description
hello	Say hello to the bot!
...	...
...	...

---

Run It Yourself

If you want to compile the bot's code to then run it in a local server, you will need:

Name	Version	Use	Links
Git	v0.9+	Clonning the repository to your computer	install docs
Go tool	v0.5.0+	Building the actual bot as an executable	install docs

Then, run open a terminal / cmd and run:

Clone the repository

git clone https://github.com/jostgrant/grunt.git

Move inside the repository

cd grunt/

Use the Golang tool to build the code

go build -o bot

Execute the code

./bot -t <bot token>

---

Credit And Thanks

Special thanks to Lieuwe Berg & Pablo Corbalán for their DiscordGo Templates; Where the code and beginner friendly readme for this project was seeded from (respectively). And of course thanks to Bruce Marriner and everyone else who's made DiscordGo possible!