diff --git a/README.md b/README.md new file mode 100644 index 00000000..7603bc7d --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# StudyLion - Discord Productivity Bot +StudyLion is a Discord bot that tracks members' study and work time while offering members to view their statistics and use productivity tools such as: To-do lists, pomodoro timers, reminders, and much more. + +**Invite the public implementation** [here](https://discord.studylions.com/invite "here"), and use it with the `!` prefix. To see a list of commands, type ,phelp. +Join the [support guild](https://discord.gg/studylions "support guild") if you have any questions or issues. + +### 🧠 The Idea +------------ +In the past couple of years, we noticed a new trend on Discord – instead of being a platform designed only for gamers, many students joined it as well, forming communities dedicated to studying and working together. +I have a study community myself called [The Study Lions](http://discord.gg/studylions "The Study Lions"). + +The community members decided to raise funds and hire an amazing developer that created our own unique study/productivity bot. + +As soon as we published the bot, hundreds of new students made their first step and started using our virtual study rooms as well! + +Over the months we got many suggestions so we kept updating and adding more and more features to the bot! + +I decided to invest further and make the bot public and open-source, so more study servers will be able to enjoy it as well, this way we can connect all study servers and create a network of students. + +### 📙 Features +------------ +StudyLion has the following primary features: +- **Camera only study rooms** +Set specific channels to force users to yse their webcam to study. +- **To-Do List** +Users can create and share their own to-do lists, and get rewards when completing a task! +- **Reminders** +Users can set their own private reminders, to drink water, stretch, or anything else they want to remember, every X minutes, hours, days, or maybe even just once. +- **Accountability Rooms** +This feature allows the users to use their coins to schedule a time to study at. +Not attending is preventing everyone in the room from getting the bonus. +- **Study and Work Statistics** +Users can view their daily, weekly, monthly and all-time stats, as well as their study streak. +- `Coming Soon` **Pomodoro Timers** +The bot will show the timer in the title of the study room and play a sound at the start and end of each session. +- **Private Study Rooms** +Allows the members to create their own private study rooms and invite their friends to join! +- **Workout Rooms** +Allows the Admins to create workout rooms with a bonus for people who workout +- **Study Tiers and Achievements** +Reward users based on their total study time, allow them to get better ranks, and show off how long they've been working. +- **Full-Scale Economy System** +reward users for studying, allow them to use the coins to buy private study rooms, schedule accountability rooms, and even change their name's color. +- **Full-Scale Moderation System** +Punish cheaters, audit-log, welcome message, and so much more using our full-scale moderation system. + + +### ❓ Tutorials +------------ +A command list and general documentation for StudyLion may be found using the `help` command. Documentation for a specific command, say congif, may be found with `help config`. Full documentation as well as user tutorials are a work in progress, new information will be added constantly. +Make sure to join the [main server](http://discord.gg/studylions "main server") to stay updated. +