Update documentation with new sorting and filtering features
- README: Document new sorting options (12 fields) - README: Document new filtering capabilities (6 filter types) - README: Document enhanced metadata fields (9 new fields) - README: Update prerequisites to mention Podman - IMPLEMENTATION_SUMMARY: Mark all phases as complete - Add API usage examples for sorting and filtering
This commit is contained in:
@@ -44,13 +44,38 @@ A modern self-hosted media library system built with Go, PostgreSQL, HTMX, and T
|
||||
- **Universal Media Support**: Single system for all media types with unified interface
|
||||
- **Rich Metadata**: Automatic extraction of title, author, series, publisher, ISBN, tags
|
||||
- **ISBN Normalization**: Automatic ISBN format normalization (removes hyphens and spaces) supporting ISBN-10 and ISBN-13 formats
|
||||
- **Advanced Search**:
|
||||
- Partial matching search across title, author, series, tags, and contributors
|
||||
- Automatic fuzzy search fallback when no partial matches found (handles typos and misspellings)
|
||||
- Real-time search results with highlighted matches
|
||||
- Keyboard navigation (↑↓ arrows, Enter to select, Escape to close)
|
||||
- Respects library visibility settings
|
||||
- **Advanced Rating**: 5-star system with half-star precision (1-10 scale)
|
||||
- **Advanced Search**:
|
||||
- Partial matching search across title, author, series, tags, and contributors
|
||||
- Automatic fuzzy search fallback when no partial matches found (handles typos and misspellings)
|
||||
- Real-time search results with highlighted matches
|
||||
- Keyboard navigation (↑↓ arrows, Enter to select, Escape to close)
|
||||
- Respects library visibility settings
|
||||
- **Dynamic Sorting**: Sort your media collection by multiple fields
|
||||
- Title (A-Z or Z-A)
|
||||
- Author (A-Z or Z-A)
|
||||
- Date added (newest or oldest first)
|
||||
- Date published (newest or oldest first)
|
||||
- Copyright year (newest or oldest first)
|
||||
- Series order (with series number)
|
||||
- Page count (shortest or longest first)
|
||||
- Genre (A-Z or Z-A)
|
||||
- **Advanced Filtering**: Filter media items with multiple options
|
||||
- Filter by author (partial match)
|
||||
- Filter by series (partial match)
|
||||
- Filter by genre (exact match)
|
||||
- Filter by language (English, Spanish, French, German, Japanese, Chinese, Korean, Russian, Italian, Portuguese)
|
||||
- Filter by copyright year range
|
||||
- Filter by items with cover images only
|
||||
- Combine multiple filters with URL state management for shareable links
|
||||
- **Enhanced Metadata**: New fields for better organization
|
||||
- Language support for multi-lingual collections
|
||||
- Edition information (2nd Edition, Revised, Collector's Edition, etc.)
|
||||
- Page count for better sorting and progress calculation
|
||||
- External service integration (Goodreads, OpenLibrary, Google Books IDs)
|
||||
- Copyright year (distinct from publication date)
|
||||
- Structured genre classification
|
||||
- Subject tags (array of subjects)
|
||||
- **Advanced Rating**: 5-star system with half-star precision (1-10 scale)
|
||||
- **Reading Progress**: User-specific progress tracking with current page and total pages
|
||||
- **Notes & Highlights**: Personal annotations and text highlighting with color customization
|
||||
- **Highlight Notes**: Link highlights to detailed notes for comprehensive annotations
|
||||
@@ -61,13 +86,13 @@ A modern self-hosted media library system built with Go, PostgreSQL, HTMX, and T
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
- Docker and Docker Compose
|
||||
- PostgreSQL database (handled by Docker)
|
||||
- **Podman** and Podman Compose (recommended) or Docker
|
||||
- PostgreSQL database (handled by Podman)
|
||||
|
||||
### Environment Setup
|
||||
1. **Create .env file**:
|
||||
```bash
|
||||
cp .env.example .env
|
||||
cp .env.example
|
||||
```
|
||||
|
||||
2. **Edit .env** with your secure values:
|
||||
@@ -78,13 +103,16 @@ DBPASS="your-secure-database-password-here"
|
||||
|
||||
### Running the Application
|
||||
```bash
|
||||
# Option 1: Using .env file
|
||||
# Using Podman (recommended)
|
||||
podman-compose up --build
|
||||
|
||||
# Using Docker
|
||||
docker-compose up --build
|
||||
|
||||
# Option 2: Direct environment variables
|
||||
export JWT_SECRET="your-secure-jwt-secret-key-here"
|
||||
export DBPASS="your-secure-database-password-here"
|
||||
docker-compose up --build
|
||||
podman-compose up --build
|
||||
```
|
||||
|
||||
Access the application at: **http://localhost:8765**
|
||||
|
||||
Reference in New Issue
Block a user