79 lines
2.1 KiB
Markdown
79 lines
2.1 KiB
Markdown
# 📚 Epook - Modern EPUB Reader
|
||
|
||
Epook is a sleek, modern EPUB reader built for Android using Jetpack Compose. It provides a clean, intuitive interface for reading your favorite ebooks with powerful features and smooth animations.
|
||
|
||
## ✨ Features
|
||
|
||
### 📖 Reading Experience
|
||
- Fluid chapter navigation with swipe gestures
|
||
- Progress tracking across reading sessions
|
||
- Interactive chapter selection through table of contents
|
||
- Smooth animations for UI elements
|
||
- Full-screen reading mode with tap controls
|
||
|
||
### 📱 User Interface
|
||
- Material Design 3 with dynamic theming
|
||
- Animated controls overlay
|
||
- Bottom navigation bar with chapter progress
|
||
- Clean, minimalist book library view
|
||
- Beautiful book cards with cover display
|
||
|
||
### ⚙️ Customization
|
||
- Adjustable font size (12-24sp)
|
||
- Customizable line height (1.0x-2.0x)
|
||
- Margin control (8-32dp)
|
||
- Multiple font family options:
|
||
- Georgia
|
||
- Roboto
|
||
- Times New Roman
|
||
- Arial
|
||
- Verdana
|
||
|
||
### 📚 Library Management
|
||
- Import EPUB files
|
||
- Automatic cover image extraction
|
||
- Book deletion with confirmation
|
||
- Reading progress persistence
|
||
- Organized book collection view
|
||
|
||
### <20><><EFBFBD><EFBFBD> Technical Features
|
||
- CSS stylesheet handling
|
||
- HTML content processing
|
||
- Efficient file management
|
||
- WebView-based rendering
|
||
- Resource caching
|
||
|
||
## 🛠️ Technical Stack
|
||
|
||
- **UI Framework**: Jetpack Compose
|
||
- **Language**: Kotlin
|
||
- **Architecture**: MVVM
|
||
- **Storage**: Room Database
|
||
- **EPUB Processing**: epublib
|
||
- **HTML Processing**: JSoup
|
||
- **Image Loading**: Coil
|
||
- **Logging**: Timber
|
||
|
||
## 🎯 Upcoming Features
|
||
|
||
- [ ] Search functionality
|
||
- [ ] Bookmarks
|
||
- [ ] Highlights and notes
|
||
- [ ] Dark mode support
|
||
- [ ] Reading statistics
|
||
- [ ] Custom themes
|
||
- [ ] Cloud sync
|
||
|
||
## 🤝 Contributing
|
||
|
||
Contributions are welcome! Feel free to submit issues and pull requests.
|
||
|
||
## 📄 License
|
||
|
||
This project is licensed under the MIT License - see the LICENSE file for details.
|
||
|
||
## 🙏 Acknowledgments
|
||
|
||
- [epublib](https://github.com/psiegman/epublib) for EPUB processing
|
||
- [Jsoup](https://jsoup.org/) for HTML parsing
|
||
- [Material Design 3](https://m3.material.io/) for design guidelines |