From 25abf9bc7fd3e6f5b5aabf745cef7d217cde4262 Mon Sep 17 00:00:00 2001
From: Joris
Date: Sat, 21 Jan 2023 14:10:47 +0100
Subject: Setup initial view of covers

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3e7e6c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Books
+
+Visualize a book library.
+
+## Book library
+
+Organize folders as you wish, only `metadata.json` files matter:
+
+```json
+{
+  "title": "Title of the Book",
+  "subtitle": "Optional subtitle",
+  "authors": [ "Author 1", "Author 2" ],
+  "authorsSort": "Author sorting",
+  "genres": [ "Foo", "Bar", "Baz" ],
+  "year": "1234",
+  "read": true
+}
+```
+
+Each `metadata.json` file correspond to a book, and there **must** be a cover
+named `cover.ext` in the same directory. Any extension works.
+
+## Show library
+
+View the book library by running:
+
+    ./bin/view browser-cmd path-to-books
+
+## Dev server
+
+Enter nix shell:
+
+    nix develop --command ./watch-command
+
+Then run the dev-server:
+
+    ./bin/dev-server path-to-books
-- 
cgit v1.2.3