diff --git a/README.md b/README.md index f34decb..7044b24 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,26 @@ -Portfolio roast bot +# Portfolio Roast bot ---- +![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white) +![Forgejo Actions](https://img.shields.io/badge/forgejo%20actions-%23FB923C.svg?style=for-the-badge&logo=forgejo&logoColor=white) +![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) +![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white) -To do: -- [ ] Database - - [ ] FAQs -- [ ] Slash commands -- [ ] Portfolio Roast Forum: One tag only +![Portfolio Roast Bot](./images/portfolio-roast-bot.webp) -FAQ table -- ID: Primary Key -- Guild ID (Server ID): FK string -- title: string -- description: string \ No newline at end of file +## Purpose + +- Made for [Anthony Sistilli's Discord Server](https://stan.store/anthonysistilli) + +Before the Discord Bot was added to the server, users giving constructive criticisms to portfolio websites would often refer to the FAQ forum of portfolio website tips and copy message links of existing pointers. + +With the Portfolio Roast bot, users can use slash commands to quickly give insightful tips on avoiding the mistakes made on different portfolio websites. + +## Credits + +- [Anthony Sistilli](https://www.youtube.com/@AnthonySistilli) + - Discord server owner + - Did not give any input + - Probably busy with his startup +- [Ryan Lee](https://rython.dev/) (Main Developer) +- Filipsys (Portfolio tips FAQ) +- Et al. (other server moderators) \ No newline at end of file diff --git a/images/portfolio-roast-bot.webp b/images/portfolio-roast-bot.webp new file mode 100644 index 0000000..2888639 Binary files /dev/null and b/images/portfolio-roast-bot.webp differ