Update README
This commit is contained in:
@@ -1,15 +1,60 @@
|
|||||||
# kaczynski-bot-2.0
|
# kaczynski-bot-2.0
|
||||||
|
|
||||||
To install dependencies:
|
A Discord bot built with [Bun](https://bun.com).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Install dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun install
|
bun install
|
||||||
```
|
```
|
||||||
|
|
||||||
To run:
|
Create a `.env.development` file with:
|
||||||
|
|
||||||
```bash
|
```
|
||||||
bun run
|
DISCORD_TOKEN=your-bot-token
|
||||||
```
|
```
|
||||||
|
|
||||||
This project was created using `bun init` in bun v1.3.0. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
|
## Development
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
Commands live in `src/cmd/registry/` and are loaded automatically at startup — drop a file default-exporting a `Command` in that folder to register it, no manual wiring required.
|
||||||
|
|
||||||
|
## Data persistence
|
||||||
|
|
||||||
|
Bot state (e.g. limbo mode) is persisted to `data/data.json` via `DataService`. That path is gitignored.
|
||||||
|
|
||||||
|
## Production build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun run build
|
||||||
|
```
|
||||||
|
|
||||||
|
Bundles `src/index.ts` and every file in `src/cmd/registry/` into `dist/`. Run the result with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun dist/index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
|
||||||
|
Build the image:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t kaczynski-bot .
|
||||||
|
```
|
||||||
|
|
||||||
|
Run it, mounting a volume so `data/data.json` survives container restarts:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -d \
|
||||||
|
-e DISCORD_TOKEN=your-bot-token \
|
||||||
|
-v kaczynski-bot-data:/app/data \
|
||||||
|
kaczynski-bot
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user