Skip to content

Commit c6f5644

Browse files
committed
Update README
1 parent cba4767 commit c6f5644

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This is a ticket bot that aims to provide a free and open source solution for ma
99
## Table of Contents
1010
- [🛠️ Installation](#installation)
1111
- [✨ Features](#features)
12-
- [💻 Usage](#usage)
1312
- [📚 Documentation](#documentation)
1413
- [🐛 Bug Reporting](#bug-reporting)
1514
- [📃 License](#license)
@@ -20,6 +19,9 @@ This is a ticket bot that aims to provide a free and open source solution for ma
2019
3. Change to the project directory, for example: `cd ticket-bot-project`
2120
4. Run `npm install` to install the dependencies
2221
5. Rename .env.example to .env and config.yml.example to config.yml
22+
6. Open .env file and fill it with your bot's token, guild ID and client ID
23+
7. Open config.yml to configure the settings and messages to your liking, make sure to properly configure the ticket categories
24+
8. Start the bot: `npm start`
2325

2426
## Features
2527

@@ -50,14 +52,10 @@ This is a ticket bot that aims to provide a free and open source solution for ma
5052
- Claim/Unclaim Tickets
5153
- Move tickets to another category
5254
- Pin tickets in a category
53-
54-
## Usage
55-
1. Open .env file and fill it with your bot's token, guild ID and client ID
56-
2. Open config.yml to configure the settings and messages to your liking, make sure to properly configure the ticket categories
57-
3. Start the bot: `npm start`
55+
- Add a custom slowmode to a ticket
5856

5957
## Documentation
60-
This project is still new, a wiki/documentation for it will be released in the future.
58+
The Wiki will be improved over time and can be found here: https://github.com/ralphkb/sentinel-tickets/wiki
6159

6260
## Bug Reporting
6361
- For bug reports, open an issue [here](https://github.com/ralphkb/sentinel-tickets/issues).

0 commit comments

Comments
 (0)