docs: Add notification compression documentation
- Update README with feature description - Add configuration section for notification compression - Create demo script showcasing the feature - Document all supported platforms (GitLab, GitHub, Jira, etc.) - Provide usage examples and configuration options
This commit is contained in:
32
README.md
32
README.md
@@ -12,6 +12,7 @@ A CLI tool for syncing Microsoft Outlook email, calendar, and tasks to local fil
|
||||
- **TUI Dashboard**: Interactive terminal dashboard for monitoring sync progress
|
||||
- **Daemon Mode**: Background daemon with proper Unix logging
|
||||
- **Cross-Platform**: Works on macOS, Linux, and Windows
|
||||
- **Smart Notification Compression**: Automatically detects and compresses transactional notification emails (GitLab, GitHub, Jira, Confluence, Datadog, Renovate) into terminal-friendly summaries
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -50,6 +51,37 @@ mkdir -p ~/.local/share/luk
|
||||
|
||||
Create a configuration file at `~/.config/luk/config.env`:
|
||||
|
||||
### Notification Email Compression
|
||||
|
||||
LUK includes intelligent notification email compression to reduce visual noise from automated emails (GitLab, GitHub, Jira, Confluence, Datadog, Renovate). Configure it in `~/.config/luk/mail.toml`:
|
||||
|
||||
```toml
|
||||
[content_display]
|
||||
# Enable/disable notification compression
|
||||
compress_notifications = true
|
||||
|
||||
# Compression mode:
|
||||
# - "summary": Brief one-page view (default)
|
||||
# - "detailed": More details in structured format
|
||||
# - "off": Disable compression, show full emails
|
||||
notification_compression_mode = "summary"
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- **Automatic detection**: Identifies notification emails by sender domain and subject patterns
|
||||
- **Type-specific summaries**: Extracts relevant info per platform (pipeline IDs, PR numbers, etc.)
|
||||
- **Terminal-friendly formatting**: Clean markdown with icons and clear hierarchy
|
||||
- **Toggle support**: Press `m` in mail view to switch between compressed and full email
|
||||
|
||||
**Demo:**
|
||||
```bash
|
||||
python demo_notification_compression.py
|
||||
```
|
||||
|
||||
See `mail.toml.example` for full configuration options.
|
||||
|
||||
### General Configuration
|
||||
|
||||
```bash
|
||||
# Microsoft Graph settings
|
||||
MICROSOFT_CLIENT_ID=your_client_id
|
||||
|
||||
Reference in New Issue
Block a user