stevenzamora1 / reading-log

# Reading Log
**A reading dashboard for KOReader's Bookshelf home screen, made for colour e-ink.**
Activity rings, monthly and yearly charts, your longest reads, the time of
day you read, a wall of every cover you finished this year, a book club
tracker, reading trends like Apple's Fitness app, this week against last, a
monthly challenge, library stats, a random pick from your unread books, a
quote from your highlights and a control centre for your light. That's 31
cards for the Bookshelf
plugin, plus a Dashboard that puts them together as tabbed pages (Today,
Yearly, Monthly, Trends and Library, and your own), and a Mini dashboard for
the top of the home screen.
Made on, and for, a Kobo Libra Colour.
The ring designs and the idea of a reading dashboard come from
u/fishnoogz's Reddit post.
New in 1.1: a Trends page, a Library page, pages of your own, and a Mini
dashboard for the top of the home screen.
The cards also work one by one, anywhere Bookshelf shows modules: in the
full-screen view or in the home screen's top area. On their own they take on
Bookshelf's look, including its dark theme.
## What you need
- KOReader with the
 Bookshelf plugin.
- KOReader's **Reading statistics** plugin switched on (it is by default).
 All the reading figures come from it.
- A colour screen is optional. On a black-and-white screen the colours show
 as greys.
## Install
1. Download `reading-log-1.1.0.zip` from Releases and
 unzip it.
2. Connect your e-reader to your computer by USB.
3. On the e-reader, open `.adds/koreader/settings/bookshelf/`.
 - If there is no `micromodules` folder inside `bookshelf`, create one.
 - `.adds` is a hidden folder. In macOS Finder press
 Cmd + Shift + . to show it; in Windows
 Explorer choose View > Show > Hidden items.
4. Open the zip's `micromodules` folder, select **everything inside it** (the
 `alm_*.lua` files and the `almanac` folder) and copy it into
 `.adds/koreader/settings/bookshelf/micromodules/` on the e-reader.
5. Eject the e-reader and restart KOReader.
> [!IMPORTANT]
> Use the `micromodules` folder in KOReader's **settings** folder, as above.
> Do **not** put the files in the Bookshelf plugin's own folder
> (`.adds/koreader/plugins/bookshelf.koplugin/micromodules/`). That folder is
> replaced every time Bookshelf updates, which would delete Reading Log.
Keep the `alm_*.lua` files and the `almanac` folder together: the files are
the cards, and the folder holds the code that draws them.
On other devices the folder is
`/mnt/us/koreader/settings/bookshelf/micromodules/` (Kindle) or
` /settings/bookshelf/micromodules/` (Android).
**Updating:** copy the new files in the same way and replace the old ones.
Your layout and settings are kept.
## Set up the Dashboard
The Dashboard is the version with the Today, Yearly, Monthly, Trends and
Library tabs. It is meant to fill Bookshelf's full-screen view on its own.
1. Bookshelf menu > Settings > Micro modules: turn on **Full-screen button**.
2. Tap that button, at the bottom righ