Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
outerwinnie authored Aug 30, 2024
1 parent 4062ec9 commit 48a9a1d
Showing 1 changed file with 49 additions and 23 deletions.
72 changes: 49 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,49 @@
# Goodreads-Bot

## TODO
- Ajustar las fotos de perfil

docker-compose.yml:

```
version: "2.1"
services:
goodreads-discord-bot:
image: ghcr.io/outerwinnie/goodreads-discord-bot:latest
container_name: goodreads-discord-bot
environment:
- TZ=Europe/Madrid
- CHANNEL_ID=
- GUILD_ID=
- DISCORD_TOKEN=
- LOGLEVEL={20-10}
- PGID=1000
- PUID=1000
restart: unless-stopped
```
# πŸ“š Goodreads & BookWyrm Discord Bot

A Discord bot that tracks and shares new reviews from both Goodreads and BookWyrm users directly in your server. Keep your community updated with the latest book reviews!

## ✨ Features

- πŸ”„ **Automated Review Updates**: Periodically checks for new reviews from tracked Goodreads and BookWyrm users and shares them in your Discord channel.
- βž• **Add/Remove Users**: Use slash commands to track or untrack users from Goodreads or BookWyrm.
- πŸ“Š **Interactive Embeds**: Displays reviews in rich embed format with links, ratings, and user info.

## 🐳 Docker Setup

1. **Docker Compose**:

Create a `docker-compose.yml` file with the following content:

```yaml
version: "2.1"
services:
goodreads-discord-bot:
image: ghcr.io/outerwinnie/goodreads-discord-bot:latest
container_name: goodreads-discord-bot
environment:
- TZ=Europe/Madrid
- CHANNEL_ID=
- GUILD_ID=
- DISCORD_TOKEN=
- LOGLEVEL={20-10}
- PGID=1000
- PUID=1000
restart: unless-stopped
```
2. **Run the bot**:
```bash
docker-compose up -d
```

## πŸ› οΈ Usage

### Commands

- `/add`: Track a new Goodreads or BookWyrm user.
- `/remove`: Untrack a user.
- `/review_check`: Manually trigger a review check.
- `/sync`: Sync the bot commands (for developers).


0 comments on commit 48a9a1d

Please sign in to comment.