chore: updated docs
02375c34
1 file(s) · +11 −10
| 4 | 4 | ||
| 5 | 5 | - Single binary with embedded assets |
|
| 6 | 6 | - Password authentication with session cookies |
|
| 7 | - | - Track books across Read, Reading, and Want to Read |
|
| 7 | + | - Track books across Reading, Read, and Want to Read (labels customizable from admin) |
|
| 8 | 8 | - Google Books search to add titles with cover art and ISBN |
|
| 9 | + | - Barcode scanning for ISBN entry (native `BarcodeDetector` with ZXing fallback) |
|
| 10 | + | - Library search from the admin page (title / author / ISBN) |
|
| 11 | + | - Toggle between inline category sections and a filter-nav layout via `LIBRARY_DISPLAY_MODE` |
|
| 9 | 12 | - Per-book notes |
|
| 10 | 13 | - JSON API for listing and fetching books |
|
| 11 | 14 | - Dark themed UI with Commit Mono font |
|
| 24 | 27 | | `HOST` | Server bind address | `127.0.0.1` | |
|
| 25 | 28 | | `PORT` | Server port | `3000` | |
|
| 26 | 29 | | `COOKIE_SECURE` | Enable HTTPS-only cookies | `false` | |
|
| 30 | + | | `LIBRARY_DISPLAY_MODE` | Public index layout: `inline` (stacked sections) or `nav` (filter buttons in header) | `inline` | |
|
| 27 | 31 | ||
| 28 | 32 | The `GOOGLE_BOOKS_API_KEY` is optional — searches work without it but are rate-limited. |
|
| 29 | 33 | ||
| 53 | 57 | ||
| 54 | 58 | ## Use |
|
| 55 | 59 | ||
| 56 | - | Your library is publicly viewable at `/`, which redirects to `/read`. Three tabs split the collection: |
|
| 60 | + | Your library is publicly viewable at `/`. Layout depends on `LIBRARY_DISPLAY_MODE`: |
|
| 57 | 61 | ||
| 58 | - | | Page | Description | |
|
| 59 | - | |---|---| |
|
| 60 | - | | `/read` | Books you've finished | |
|
| 61 | - | | `/reading` | Books you're currently reading | |
|
| 62 | - | | `/want` | Books you want to read | |
|
| 62 | + | - `inline` — all non-empty categories rendered as stacked sections on one page. |
|
| 63 | + | - `nav` — header filter buttons switch between categories via `?category=reading|read|want`. |
|
| 63 | 64 | ||
| 64 | 65 | ### Admin |
|
| 65 | 66 | ||
| 67 | 68 | ||
| 68 | 69 | | Page | Description | |
|
| 69 | 70 | |---|---| |
|
| 70 | - | | `/admin` | Admin dashboard listing every book in your library | |
|
| 71 | - | | `/admin/search?q=...` | Search Google Books to add a title | |
|
| 71 | + | | `/admin` | Admin dashboard listing every book. Supports library search via `?q=...` (title / author / ISBN). | |
|
| 72 | + | | `/admin/search?q=...` | Search Google Books to add a title. ISBN field supports barcode scanning. | |
|
| 72 | 73 | ||
| 73 | - | From the admin dashboard you can change a book's status, save notes, or remove a book. |
|
| 74 | + | From the admin dashboard you can change a book's status, save notes, rename category labels, or remove a book. |
|
| 74 | 75 | ||
| 75 | 76 | ### API |
|
| 76 | 77 | ||