From e35d39473655ac5bbe352d053c9bc673b49f45b7 Mon Sep 17 00:00:00 2001 From: John O'Keefe Date: Thu, 20 Aug 2026 14:14:52 -0400 Subject: [PATCH] docs(readme): update device support matrix to current state MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Supported-devices table: Kobo moves from 'full support' to 'coming soon, use KOReader on Kobo today'; mobile apps 'coming later' with no speculative date - Universal-sync pitch now states what actually syncs (position, bookmarks, highlights, notes) between KOReader and the web - Frame KEPUB conversion and collection shelf mappings as groundwork for upcoming native Kobo support - Fix dead links: docs/DEVELOPMENT.md → docs/developer/development.md and docs/contributing/DEVELOPMENT.md → actual path --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 08caec9..48b3c03 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A modern self-hosted media library system built with Go, PostgreSQL, HTMX, and T ## ✨ Why Bookhoard? -**🔄 Universal Sync**: Your reading progress, highlights, and notes sync automatically across all your devices - KOReader, Kobo, web, and mobile. +**🔄 Universal Sync**: Your reading position, bookmarks, highlights, and notes sync automatically between KOReader and the web - with native Kobo sync and mobile apps coming later. **📱 Multi-Library**: Organize your ebooks, comics, and manga with per-library folders and smart collections. @@ -52,13 +52,13 @@ The first user to register automatically becomes an admin. ### Universal Cross-Platform Sync -- **Real-Time Progress**: Turn a page on your Kindle, see it on your phone +- **Real-Time Progress**: Turn a page on your e-reader, see it in your browser - **Format-Aware**: EPUB CFI, page numbers, percentages - all handled correctly - **Offline Queue**: Changes sync when you reconnect, priority-processed - **Conflict Resolution**: Smart handling when same book read on multiple devices - **Book Matching**: Automatic matching using SHA-256, ISBN, UUID - **OPDS Catalog**: Wireless book delivery to e-readers over Wi-Fi -- **Format Conversion**: On-the-fly EPUB→KEPUB for Kobo devices +- **Format Conversion**: On-the-fly EPUB→KEPUB conversion (for upcoming native Kobo support) ### Media Management @@ -74,7 +74,7 @@ The first user to register automatically becomes an admin. ### Smart Collections - **Auto-Assign Rules**: Automatically add books based on genre, author, series, tags, language, publisher, year -- **Device Shelf Mappings**: Sync collections to Kobo shelves and KOReader categories +- **Device Shelf Mappings**: Map collections to device shelves (used by native Kobo sync, coming soon) - **Test Before Creating**: Preview which books match your rules ### Library Organization @@ -102,8 +102,8 @@ The first user to register automatically becomes an admin. - **[docs/user/calibre-integration.md](docs/user/calibre-integration.md)** - Calibre library integration - **[docs/user/sync-guide.md](docs/user/sync-guide.md)** - Understanding and using universal sync -- **[docs/user/devices/kobo-setup.md](docs/user/devices/kobo-setup.md)** - Kobo e-reader configuration - **[docs/user/devices/koreader-setup.md](docs/user/devices/koreader-setup.md)** - KOReader configuration +- **[docs/user/devices/kobo-setup.md](docs/user/devices/kobo-setup.md)** - Kobo e-reader configuration (coming soon) - **[docs/user/user-guide.md](docs/user/user-guide.md)** - General user guide - **[docs/user/admin-guide.md](docs/user/admin-guide.md)** - Admin features and configuration - **[docs/user/settings-guide.md](docs/user/settings-guide.md)** - Settings and preferences @@ -111,18 +111,18 @@ The first user to register automatically becomes an admin. ### For Developers - **[docs/developer/api/api-reference.md](docs/developer/api/api-reference.md)** - Complete API documentation -- **[docs/contributing/DEVELOPMENT.md](docs/contributing/DEVELOPMENT.md)** - Development workflow +- **[docs/contributing/development.md](docs/contributing/development.md)** - Development workflow --- ## 🎯 Supported Devices -| Platform | Sync | OPDS | Status | -| ---------------- | ---- | ---- | ------------------------ | -| **Web Browser** | ✅ | ✅ | Full support | -| **KOReader** | ✅ | ✅ | Kindle, Kobo, PocketBook | -| **Kobo Devices** | ✅ | ✅ | Clara, Libra, Sage, etc. | -| **Mobile Apps** | 🚧 | 🚧 | Coming Q2 2026 | +| Platform | Sync | OPDS | Status | +| ---------------- | ---- | ---- | ------------------------------------------------------------- | +| **Web Browser** | ✅ | ✅ | Full support | +| **KOReader** | ✅ | ✅ | Runs on Kindle, Kobo, PocketBook hardware | +| **Kobo Devices** | 🚧 | 🚧 | Native Kobo sync coming soon (use KOReader on Kobo today) | +| **Mobile Apps** | 🚧 | 🚧 | Android/iOS apps coming later | --- @@ -162,7 +162,7 @@ bruno run ## 🤝 Contributing -We welcome contributions! Please see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) for guidelines. +We welcome contributions! Please see [docs/developer/development.md](docs/developer/development.md) for guidelines. ---