Croc/croccybot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(readme): Fix some typos.

Browse Source
This commit is contained in:
Interitio
2021-10-19 21:00:04 +03:00
committed by GitHub
parent bca9c12e8c
commit a4fdcc25a0
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,8 +1,8 @@
# StudyLion - Discord Productivity Bot # 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. StudyLion is a Discord bot that tracks members' study and work time while offering members the ability 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. [**Invite StudyLion here**](https://discord.studylions.com/invite "here"), and get started with `!help`.
Join the [support guild](https://discord.gg/studylions "support guild") if you have any questions or issues. Join the [**support server**](https://discord.gg/studylions "support server") or start a [**discussion**](https://github.com/StudyLions/StudyLion/discussions "disscussion") if you have any questions or issues.
### 🧠 The Idea ### 🧠 The Idea
------------ ------------
@@ -21,14 +21,14 @@ I decided to invest further and make the bot public and open-source, so more stu
------------ ------------
StudyLion has the following primary features: StudyLion has the following primary features:
- **Camera only study rooms** - **Camera only study rooms**
Set specific channels to force users to yse their webcam to study. Set specific channels to force users to use their webcam to study.
- **To-Do List** - **To-Do List**
Users can create and share their own to-do lists, and get rewards when completing a task! Users can create and share their own to-do lists, and get rewards when completing a task!
- **Reminders** - **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. 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** - **Accountability Rooms**
This feature allows the users to use their coins to schedule a time to study at. 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. Not attending prevents everyone in the room from getting the bonus.
- **Study and Work Statistics** - **Study and Work Statistics**
Users can view their daily, weekly, monthly and all-time stats, as well as their study streak. Users can view their daily, weekly, monthly and all-time stats, as well as their study streak.
- `Coming Soon` **Pomodoro Timers** - `Coming Soon` **Pomodoro Timers**
@@ -36,17 +36,16 @@ The bot will show the timer in the title of the study room and play a sound at t
- **Private Study Rooms** - **Private Study Rooms**
Allows the members to create their own private study rooms and invite their friends to join! Allows the members to create their own private study rooms and invite their friends to join!
- **Workout Rooms** - **Workout Rooms**
Allows the Admins to create workout rooms with a bonus for people who workout Allows the Admins to create workout rooms with a bonus for people who workout.
- **Study Tiers and Achievements** - **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. 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** - **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. 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** - **Full-Scale Moderation System**
Punish cheaters, audit-log, welcome message, and so much more using our full-scale moderation system. Punish cheaters, audit-log, welcome message, and so much more using our full-scale moderation system.
### ❓ Tutorials ### ❓ 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`. A command list and general documentation for StudyLion may be found using the `!help` command, and documentation for a specific command, e.g. `config`, may be found with `!help config`.
Make sure to check the full documentation [here](https://www.notion.so/izabellakis/StudyLion-Bot-Tutorials-f493268fcd12436c9674afef2e151707") to stay updated. Make sure to check the [full documentation](https://www.notion.so/izabellakis/StudyLion-Bot-Tutorials-f493268fcd12436c9674afef2e151707 "StudyLion Tutorial") to stay updated.