Skip to content

Commit e10000e

Browse files
committed
Update README.md
1 parent f7b6edd commit e10000e

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ A Rust CLI tool that generates a beautiful static website from your KoReader lib
1010
- 📝 **Annotations & Highlights**: Shows all your KoReader highlights and notes with elegant formatting
1111
- 📖 **Book Details**: Individual pages for each book with metadata and organized annotations
1212
- 📊 **Reading Statistics**: Track your reading habits with detailed statistics including reading time, pages read, activity heatmaps, and weekly breakdowns
13+
- 📅 **Reading Calendar**: Monthly calendar view showing your reading activity with books read on each day and monthly statistics
1314
- 📈 **Per-Book Statistics**: Detailed statistics for each book including session count, average session duration, reading speed, and last read date
1415
- 🔍 **Search & Filter**: Search through your library by title, author, or series, with filters for reading status
1516
- 🚀 **Static Site**: Generates a complete static website you can host anywhere
@@ -184,6 +185,8 @@ site/
184185
├── index.html # Main library page
185186
├── statistics/
186187
│ └── index.html # Reading statistics dashboard
188+
├── calendar/
189+
│ └── index.html # Reading calendar view
187190
├── books/ # Individual book pages
188191
│ ├── book-id1/
189192
│ │ └── index.html # Book detail page with annotations
@@ -194,16 +197,20 @@ site/
194197
│ ├── book-id1.webp
195198
│ └── book-id2.webp
196199
├── css/
197-
│ └── style.css # Compiled Tailwind CSS
200+
│ ├── style.css # Compiled Tailwind CSS
201+
│ └── event-calendar.min.css # Event calendar library styles
198202
├── js/
199203
│ ├── book_list.js # Search and filtering functionality
200204
│ ├── lazy-loading.js # Image lazy loading
201205
│ ├── statistics.js # Statistics page functionality
202-
│ └── heatmap.js # Activity heatmap visualization
206+
│ ├── calendar.js # Calendar functionality
207+
│ ├── heatmap.js # Activity heatmap visualization
208+
│ └── event-calendar.min.js # Event calendar library
203209
└── json/ # Statistics data (when available)
204210
├── week_0.json # Weekly statistics data
205211
├── week_1.json
206212
├── ...
213+
├── calendar_data.json # Calendar events and book data
207214
├── daily_activity_2023.json # Daily activity data for heatmap
208215
├── daily_activity_2024.json
209216
└── ...
@@ -213,6 +220,10 @@ site/
213220

214221
Design and feature inspiration taken from [KoInsight](https://github.com/GeorgeSG/KoInsight) - an excellent alternative that focuses more on statistics and also supports acting as a KOReader sync server. If you're primarily interested in reading stats rather than highlights and annotations, definitely check it out!
215222

223+
The calendar feature is powered by [EventCalendar](https://github.com/vkurko/calendar) - a lightweight, full-featured JavaScript event calendar library.
224+
225+
Styled with [Tailwind CSS](https://tailwindcss.com/) for modern, responsive design.
226+
216227
## Disclaimer
217228

218229
This is a weekend project and was built for personal use - it relies heavily on AI-generated code. While I've tested everything and use it daily, I take no responsibility for any issues you might encounter. Use at your own risk.

0 commit comments

Comments
 (0)