mirror of
https://github.com/ssyyhhrr/discord.py-bot.git
synced 2025-11-08 13:13:46 -05:00
Create README.md
This commit is contained in:
Rhys
129
README.md
Normal file
129
README.md
Normal file
@@ -0,0 +1,129 @@
|
||||
<a name="readme-top"></a>
|
||||
|
||||
<!-- PROJECT SHIELDS -->
|
||||
[![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]
|
||||
|
||||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<div align="center">
|
||||
<h3 align="center">discord.py-bot</h3>
|
||||
|
||||
<p align="center">
|
||||
A simple Discord bot created with discord.py for a University project.
|
||||
<br />
|
||||
<a href="https://github.com/ssyyhhrr/discord.py-bot/issues">Report Bug</a>
|
||||
·
|
||||
<a href="https://github.com/ssyyhhrr/discord.py-bot/issues">Request Feature</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
<details>
|
||||
<summary>Table of Contents</summary>
|
||||
<ol>
|
||||
<li>
|
||||
<a href="#about-the-project">About The Project</a>
|
||||
<ul>
|
||||
<li><a href="#built-with">Built With</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getting-started">Getting Started</a>
|
||||
<ul>
|
||||
<li><a href="#prerequisites">Prerequisites</a></li>
|
||||
<li><a href="#installation">Installation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#roadmap">Roadmap</a></li>
|
||||
<li><a href="#contributing">Contributing</a></li>
|
||||
<li><a href="#license">License</a></li>
|
||||
<li><a href="#contact">Contact</a></li>
|
||||
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
||||
</ol>
|
||||
</details>
|
||||
|
||||
<!-- ABOUT THE PROJECT -->
|
||||
## About The Project
|
||||
|
||||
<img src="https://sy.hr/files/2022-11-06_16-54-42_Y2nvUfbHVmCOuz9W.png" height="300"/>
|
||||
|
||||
A simple Discord bot created with discord.py for a University project.
|
||||
|
||||
<!-- GETTING STARTED -->
|
||||
## 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 EXAMPLES -->
|
||||
## Usage
|
||||
|
||||
```
|
||||
py main.py
|
||||
```
|
||||
|
||||
<!-- CONTRIBUTING -->
|
||||
## 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 -->
|
||||
## License
|
||||
|
||||
Distributed under the MIT License. See `LICENSE.txt` for more information.
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
<!-- CONTACT -->
|
||||
## 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)
|
||||
|
||||
<!-- MARKDOWN LINKS & IMAGES -->
|
||||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
||||
[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/
|
||||
Reference in New Issue
Block a user