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
2022-01-31 22:08:51 +01:00
parent 0d14da1df3
commit ce588b10fa
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -9,7 +9,7 @@ A discord bot that allows you to set a date, [cron](https://en.wikipedia.org/wik
## Usage ## Usage
Type /remind in a Discord server where this bot exists to get a list of slash commands you can use. Type `/remind` in a Discord server where this bot exists to get a list of slash commands you can use.
## Installation ## Installation
@ -36,16 +36,17 @@ You have two choices, [install directly on your computer](#Install-directly-on-y
- Windows 10: Click the View Tab in File Explorer and click the box next to File name extensions. - Windows 10: Click the View Tab in File Explorer and click the box next to File name extensions.
- Windows 11: Click View -> Show -> File name extensions. - Windows 11: Click View -> Show -> File name extensions.
- Open a terminal in the repository folder. - Open a terminal in the repository folder.
- Windows 10: Shift + right-click in the folder and select `Open PowerShell window here`.' - Windows 10: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here`
- Windows 11: Shift + right-click in the folder and select `Open in Windows Terminal`.' - Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open in Windows Terminal`
- Install requirements: - Install requirements:
- `poetry install` - `poetry install`
- (You may have to restart your terminal if it can't find the `poetry` command) - (You may have to restart your terminal if it can't find the `poetry` command)
- Start the bot with: - Start the bot with:
- `poetry run bot` - `poetry run bot`
- You can stop the bot with ctrl + c. - You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>.
Note: You will need to run `poetry install` again if poetry.lock has been modified. Note: You will need to run `poetry install` again if poetry.lock has been modified.
Note: It can take up to one hour for the slash commands to be visible in the Discord server. Note: It can take up to one hour for the slash commands to be visible in the Discord server.
### Docker ### Docker
@ -58,11 +59,11 @@ Docker Hub: [thelovinator/discord-reminder-bot](https://hub.docker.com/r/thelovi
- Windows 10: Click the View Tab in File Explorer and click the box next to File name extensions. - Windows 10: Click the View Tab in File Explorer and click the box next to File name extensions.
- Windows 11: Click View -> Show -> File name extensions. - Windows 11: Click View -> Show -> File name extensions.
- Open a terminal in the extras folder. - Open a terminal in the extras folder.
- Windows 10: Shift + right-click in the folder and select `Open PowerShell window here` - Windows 10: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here`
- Windows 11: Shift + right-click in the folder and select `Open in Windows Terminal` - Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open in Windows Terminal`
- Run the Docker Compose file: - Run the Docker Compose file:
- `docker-compose up` - `docker-compose up`
- You can stop the bot with ctrl + c. - You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>.
- If you want to run the bot in the background, you can run `docker-compose up -d`. - If you want to run the bot in the background, you can run `docker-compose up -d`.
## Help ## Help