From 8f6a42f8b48826de82f7a926b4277156d36dd07b Mon Sep 17 00:00:00 2001 From: Jakob Moser Date: Sun, 22 Jun 2025 15:43:16 +0200 Subject: [PATCH] Restructure: Make serve a level 4 subsection --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7bac42d..22a675a 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,11 @@ export SONG_LIBRARY=/path/to/library ### Web-based catalogue UI -**Launch server for a web-based UI to browse the catalogue**, supporting to create a list of favorites. +**A web-based UI to browse the song library.** It supports searching by title and artist, and allows to mark and unmark favorites on the client side (using local storage). + +#### Serve + +**Launch a server for the catalogue UI** on localhost. Mostly useful for development purposes. ℹ️ This is completely risk-free, as it does not change files. @@ -34,7 +38,7 @@ export SONG_LIBRARY=/path/to/library python3 -m karaokatalog.ui.serve $SONG_LIBRARY ``` -To speed up the start, use jsonification to create and persist a JSON of all songs in the library root dir before starting this UI. +To speed up the start, use jsonification to create and persist a JSON of all songs in the library root dir before starting this UI. ### Deduplication