Skip to content

Commit 04ca85b

Browse files
authored
Merge pull request PartMan7#44 from TurboRx/main
docs: Improve README.md
2 parents 55b1e94 + b1b51ca commit 04ca85b

1 file changed

Lines changed: 41 additions & 9 deletions

File tree

README.md

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,52 @@
11
# PartBot
22

3-
_but better_
3+
_A morden rewrite of PartBot for Pokemon Showdown_
44

55
---
66

7-
Hiya! This is an ongoing effort to rewrite [PartBot](https://github.com/PartMan7/PartBot) from the bottom-up, with
8-
better practices than the steaming pile of bamboo sticks that currently supports it.
7+
Hiya! This is an ongoing effort to rewrite [PartBot](https://github.com/PartMan7/PartBot) from the bottom-up, with better practices than the steaming pile of bamboo sticks that currently supports it.
98

109
This might take a while...
1110

12-
- Cloning and Installing
13-
- Developing
14-
- [Planned Features](https://github.com/PartMan7/PartBot/labels/enhancement)
15-
- [Known Issues](https://github.com/PartMan7/PartBot/labels/bug)
16-
- [Suggestions, Bug Reports, and Feedback](https://github.com/PartMan7/PartBot/tree/main/docs/SUGGESTIONS.md)
17-
- [Credits](#Credits)
11+
## Features
12+
13+
- Modular and extensible TypeScript codebase
14+
- Real-time file watching and reloads
15+
- Rich set of utilities for tournaments, games (e.g., Chess), and more
16+
17+
## Getting Started
18+
19+
### Prerequisites
20+
21+
- [Node.js](https://nodejs.org/) (v18+ recommended)
22+
- [npm](https://www.npmjs.com/)
23+
- [MongoDB](https://www.mongodb.com/) (for persistence)
24+
25+
### Installation
26+
27+
1. **Clone the repository**
28+
```bash
29+
git clone https://github.com/PartMan7/PartBot.git
30+
cd PartBot
31+
```
32+
33+
2. **Install dependencies**
34+
```bash
35+
npm install
36+
```
37+
38+
3. **Setup environment variables**
39+
40+
Modify the `.env` file (which is automatically copied from `.env.example`).
41+
42+
4. **Start the bot**
43+
```bash
44+
npm start
45+
```
46+
47+
## Suggestions, Bug Reports, and Feedback
48+
49+
See [Suggestions & Feedback](https://github.com/PartMan7/PartBot/tree/main/docs/SUGGESTIONS.md) for ideas, bugs, and requests.
1850

1951
## Credits
2052

0 commit comments

Comments
 (0)