discord-tldr/README.md

89 lines
2.2 KiB
Markdown

# Discord TLDR
Automatically summarize Discord server conversations and post digests to a dedicated channel. Never miss important discussions again.
## Two Ways to Use
### 🤖 Option 1: Clawdbot Skill (Recommended if you use Clawdbot)
Zero code required. Just configure cron jobs and let Clawdbot handle the rest.
**Pros:**
- No separate bot to host
- Uses your existing Clawdbot setup
- AI summarization built-in
- Easy to customize prompts
**Setup:** See [`skill/SKILL.md`](skill/SKILL.md)
---
### 🐍 Option 2: Standalone Bot
A self-contained Python Discord bot. Deploy anywhere.
**Pros:**
- Works without Clawdbot
- Full control over deployment
- Docker-ready
- Manual trigger commands
**Setup:** See [`standalone/README.md`](standalone/README.md)
---
## How It Works
1. **Collect** - Reads messages from all accessible channels since last summary
2. **Summarize** - Uses Claude/GPT to create a concise digest
3. **Post** - Sends the summary to your #tldr channel
4. **Repeat** - Runs on schedule (default: 6 AM, 1 PM, 10 PM)
## Example Output
```
📋 **TLDR Summary** (Jan 25, 2026 - 1:00 PM)
Busy morning! Major progress on the API, some hiring discussions,
and the eternal tabs-vs-spaces debate resurfaces.
**#general**
• Welcomed @newbie to the team
• Q1 roadmap discussion - focusing on mobile first
• Friday team lunch @ 12:30
**#engineering**
• Shipped v2.1.0 to staging
• Found and fixed the auth token bug
• Code review backlog cleared
**#hiring**
• 3 new senior eng candidates in pipeline
• Technical interview scheduled for Thursday
**Action Items:**
- [ ] @alice: Finalize API docs by Wednesday
- [ ] @bob: Set up staging environment monitoring
- [ ] Everyone: Submit Q1 goals by EOW
```
## Why?
- **Async-friendly**: Not everyone can keep up with Discord in real-time
- **Context preservation**: Important decisions don't get buried
- **Onboarding**: New members can quickly catch up on team dynamics
- **Documentation**: Creates a lightweight log of team activity
## Contributing
PRs welcome! Ideas for improvement:
- Slack/Teams support
- Weekly digest mode
- Thread summarization
- Sentiment analysis
- Custom summary templates
## License
MIT - do whatever you want with it