From a110c200e86d2325af07167531fac0f61d9681a0 Mon Sep 17 00:00:00 2001
From: Joris Guyonvarch
Date: Fri, 26 Dec 2025 18:41:26 +0100
Subject: Switch to GUI to manage the library

Allow to regroup the CLI and the view into one unique tool.
---
 README.md | 50 +++++++++++++++++---------------------------------
 1 file changed, 17 insertions(+), 33 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index d676bf2..d6c9651 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,25 @@
-# Books
+Manage a book library.
 
-Visualize a book library.
+- Group by progress
+- Associate any number of ebooks to each book
+- Transfer individual books to ereader
 
-## Book library
+# Running
 
-Organize folders as you wish, only `metadata.toml` files matter:
-
-```toml
-title = "Title of the Book"
-subtitle = "Optional subtitle"
-authors = [ "Author 1", "Author 2" ]
-authorsSort = "Author sorting"
-genres = [ "Foo", "Bar", "Baz" ]
-year = 1234
-summarry = """
-First paragraph
-Second paragraph
-"""
-read = "Read"
+```sh
+nix develop --command books
 ```
 
-`read` is one of: `Read`, `Unread`, `Reading`, `Stopped`.
-
-Each `metadata.toml` file correspond to a book, and there **must** be a cover
-named `cover.ext` in the same directory. Any extension works.
-
-## Dev server
-
-In nix shell (`nix develop`), run:
+# Testing
 
-    ./bin/dev-server path-to-books
-
-## Show library
-
-    make
-    BOOKS_LIBRARY=path-to-books BOOKS_BROWSER=firefox python src/main.py library
+```sh
+pytest
+```
 
-## Add book
+# Improvements
 
-    BOOKS_LIBRARY=path-to-books python src/main.py new optional-path-to-ebook
+- book flow: keep header bar visible when scrolling down
+- filters:
+    - textual search
+    https://stackoverflow.com/questions/55828169/how-to-filter-gtk-flowbox-children-with-gtk-entrysearch
+    - select by genre
-- 
cgit v1.2.3