TheLovinator/discord-reminder-bot
1
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Joakim Hellsén
2021-08-08 14:51:30 +02:00
parent 4a8c212c1e
commit e08cf02a65
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,10 +1,11 @@
# Discord-reminder-bot # Discord-reminder-bot
Discord bot that allows you to set date, cron and interval reminders. <p align="center">
<img src="https://raw.githubusercontent.com/TheLovinator1/discord-reminder-bot/master/Bot.png" title="/remind add message_reason: Remember to feed the cat! message_date: 2 November 2025 14:00 CET"/>
</p>
<p align="center"><sup>Theme is [DiscordNight by KillYoy](https://github.com/KillYoy/DiscordNight)<sup></p>
![/remind add message_reason: Remember to feed the cat! message_date: 2 November 2025 14:00 CET](/Bot.png) A discord bot that allows you to set date, cron, and interval reminders.
<sup>Theme is [DiscordNight by KillYoy](https://github.com/KillYoy/DiscordNight)<sup>
## Usage ## Usage
@ -15,7 +16,7 @@ Type /remind in a Discord server where this bot exists to get a list of slash co
* `BOT_TOKEN` - Discord bot token ([Where to get one](https://discord.com/developers/applications)) * `BOT_TOKEN` - Discord bot token ([Where to get one](https://discord.com/developers/applications))
* `TIMEZONE` - Your time zone. You want the TZ database name. ([List of time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)). Defaults to `Europe/Stockholm` * `TIMEZONE` - Your time zone. You want the TZ database name. ([List of time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)). Defaults to `Europe/Stockholm`
* `SQLITE_LOCATION` - (Optional) Where to store the database. Defaults to `/jobs.sqlite` * `SQLITE_LOCATION` - (Optional) Where to store the database. Defaults to `/jobs.sqlite`
* `LOG_LEVEL` - Can be CRITICAL, ERROR, WARNING, INFO or DEBUG. Defaults to `INFO` * `LOG_LEVEL` - Can be CRITICAL, ERROR, WARNING, INFO, or DEBUG. Defaults to `INFO`
## Installation ## Installation
@ -25,7 +26,7 @@ You have two choices, [install directly on your computer](#Install-directly-on-y
* Install latest version of [git](https://git-scm.com/), [Python](https://www.python.org/) and [Poetry](https://python-poetry.org/docs/#installation). * Install latest version of [git](https://git-scm.com/), [Python](https://www.python.org/) and [Poetry](https://python-poetry.org/docs/#installation).
* Download project from GitHub and change directory into it. * Download project from GitHub and change directory into it.
* Open terminal in repository folder. * Open terminal in the repository folder.
* Install requirements: * Install requirements:
* `poetry install` * `poetry install`
* Rename .env.example to .env and fill it out. * Rename .env.example to .env and fill it out.