Create README.md

README.md

@@ -0,0 +1,184 @@
+<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
+<a id="readme-top"></a>
+<!--
+*** Thanks for checking out the Best-README-Template. If you have a suggestion
+*** that would make this better, please fork the repo and create a pull request
+*** or simply open an issue with the tag "enhancement".
+*** Don't forget to give the project a star!
+*** Thanks again! Now go create something AMAZING! :D
+-->
+
+
+
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![GPL License][license-shield]][license-url]
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/dorasto/discordbot">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">Doras Discord Bot</h3>
+
+  <p align="center">
+    A simple livestream notification Discord bot, built by the team who brought you <a href="https://doras.to">Doras.to</a>
+    <br />
+<!--     <a href="https://github.com/dorasto/discordbot"><strong>Explore the docs »</strong></a> -->
+    <br />
+    <br />
+    <a href="https://discord.com/oauth2/authorize?client_id=1178674222873198612">Invite the bot to your server</a>
+    ·
+    <a href="https://github.com/dorasto/discordbot/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
+    ·
+    <a href="https://github.com/dorasto/discordbot/issues/new?labels=enhancement&template=feature-request---.md">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="#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>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+![Screen Shot](https://cdn.doras.to/doras/dorasbot/Screenshot%202024-07-23%20065736.png)
+
+Doras Discord Bot is an open source GPL bot to post live stream notifications & vods to your servers. It's primarily designed for [Doras] users, however it's not required.
+
+We've decided to open source the project should you wish to host it your self. 
+
+Contributions are also welcome!
+
+### Built With
+
+![Typescript]
+![docker]
+![discordjs]
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+This is an example of how you may give instructions on setting up your project locally.
+To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+This is an example of how to list things you need to use the software and how to install them.
+* pnpm
+* docker
+
+### Installation
+
+1. Clone the repo
+2. Install packages `pnpm install`
+3. Rename `.example.env` to `.env` and provide the relevant fields
+4. Run `pnpm dev`
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [ ] YouTube live & video embeds
+
+See the [open issues](https://github.com/dorasto/discordbot/issues) for a full list of proposed features (and known issues).
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+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 GPLv3 License. See `LICENSE` for more information.
+
+
+<!-- CONTACT -->
+## Contact
+
+The Doras Team - [@doras_to](https://twitter.com/doras_to) - hi@doras.to
+
+Project Link: [https://github.com/dorasto/discordbot](https://github.com/dorasto/discordbot)
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[typescript]: https://img.shields.io/badge/typescript-3178c6?style=for-the-badge&logo=typescript&logoColor=white
+[docker]: https://img.shields.io/badge/docker-2496ec?style=for-the-badge&logo=docker&logoColor=white
+[discordjs]: https://img.shields.io/badge/discord.js-2496ec?style=for-the-badge&logo=discord&logoColor=white
+[Doras]: https://doras.to
+<!-- dummy data -->
+[contributors-shield]: https://img.shields.io/github/contributors/dorasto/discordbot.svg?style=for-the-badge
+[contributors-url]: https://github.com/dorasto/discordbot/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/dorasto/discordbot.svg?style=for-the-badge
+[forks-url]: https://github.com/dorasto/discordbot/network/members
+[stars-shield]: https://img.shields.io/github/stars/dorasto/discordbot.svg?style=for-the-badge
+[stars-url]: https://github.com/dorasto/discordbot/stargazers
+[issues-shield]: https://img.shields.io/github/issues/dorasto/discordbot.svg?style=for-the-badge
+[issues-url]: https://github.com/dorasto/discordbot/issues
+[license-shield]: https://img.shields.io/github/license/dorasto/discordbot.svg?style=for-the-badge
+[license-url]: https://github.com/dorasto/discordbot/blob/master/LICENSE
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[product-screenshot]: images/screenshot.png
+[Next-url]: https://nextjs.org/
+[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
+[React-url]: https://reactjs.org/
+[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
+[Vue-url]: https://vuejs.org/
+[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
+[Angular-url]: https://angular.io/
+[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
+[Svelte-url]: https://svelte.dev/
+[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
+[Laravel-url]: https://laravel.com
+[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
+[Bootstrap-url]: https://getbootstrap.com
+[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
+[JQuery-url]: https://jquery.com