diff --git a/README.md b/README.md new file mode 100644 index 0000000..dcfb2eb --- /dev/null +++ b/README.md @@ -0,0 +1,184 @@ + + + + + + + + +[![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] + + + + +
+
+ + Logo + + +

Doras Discord Bot

+ +

+ A simple livestream notification Discord bot, built by the team who brought you Doras.to +
+ +
+
+ Invite the bot to your server + · + Report Bug + · + Request Feature +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
  2. +
  3. + Getting Started + +
  4. +
  5. Roadmap
  6. +
  7. Contributing
  8. +
  9. License
  10. +
  11. Contact
  12. +
+
+ + + + +## 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 + +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 + +- [ ] 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 + +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 + +Distributed under the GPLv3 License. See `LICENSE` for more information. + + + +## 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) + + + +[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 + +[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