diff --git a/README.md b/README.md new file mode 100644 index 0000000..bec6c78 --- /dev/null +++ b/README.md @@ -0,0 +1,129 @@ + + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] + + +
+
+

discord.py-bot

+ +

+ A simple Discord bot created with discord.py for a University project. +
+ Report Bug + ยท + Request Feature +

+
+ + +
+ Table of Contents +
    +
  1. + About The Project + +
  2. +
  3. + Getting Started + +
  4. +
  5. Usage
  6. +
  7. Roadmap
  8. +
  9. Contributing
  10. +
  11. License
  12. +
  13. Contact
  14. +
  15. Acknowledgments
  16. +
+
+ + +## About The Project + + + +A simple Discord bot created with discord.py for a University project. + + +## Getting Started + +### Prerequisites + +[Python](https://python.org) + +### Installation + +_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ + +1. Clone the repo + ```sh + git clone https://github.com/ssyyhhrr/discord.py-bot.git + ``` +3. Install Python packages + ```sh + pip install -r requirements.txt + ``` +4. Enter your credentials in `.env` + ```env + DISCORD_TOKEN=ENTER_YOUR_DISCORD_TOKEN + DISCORD_ID=ENTER_YOUR_DISCORD_ID + ``` + + +## Usage + +``` +py main.py +``` + + +## Contributing + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + +## License + +Distributed under the MIT License. See `LICENSE.txt` for more information. + +

(back to top)

+ + +## Contact + +Your Name - [https://sy.hr/](https://sy.hr) - mail@rhysbi.shop + +Project Link: [https://github.com/ssyyhhrr/discord.py-bot](https://github.com/ssyyhhrr/discord.py-bot) + + + +[contributors-shield]: https://img.shields.io/github/contributors/ssyyhhrr/discord.py-bot.svg?style=for-the-badge +[contributors-url]: https://github.com/ssyyhhrr/discord.py-bot/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/ssyyhhrr/discord.py-bot.svg?style=for-the-badge +[forks-url]: https://github.com/ssyyhhrr/discord.py-bot/network/members +[stars-shield]: https://img.shields.io/github/stars/ssyyhhrr/discord.py-bot.svg?style=for-the-badge +[stars-url]: https://github.com/ssyyhhrr/discord.py-bot/stargazers +[issues-shield]: https://img.shields.io/github/issues/ssyyhhrr/discord.py-bot.svg?style=for-the-badge +[issues-url]: https://github.com/ssyyhhrr/discord.py-bot/issues +[license-shield]: https://img.shields.io/github/license/ssyyhhrr/discord.py-bot.svg?style=for-the-badge +[license-url]: https://github.com/ssyyhhrr/discord.py-bot/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://www.linkedin.com/in/rhys-bishop-158638214/