From 31acb6e43c07066e9a5ba404ea6c59201937c05a Mon Sep 17 00:00:00 2001 From: Joris Date: Thu, 9 Feb 2023 10:12:32 +0100 Subject: Complete documentation about reading status --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3e7e6c8..d7f5ced 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,12 @@ Organize folders as you wish, only `metadata.json` files matter: "authorsSort": "Author sorting", "genres": [ "Foo", "Bar", "Baz" ], "year": "1234", - "read": true + "read": "Read" } ``` +`read` is one of: `Read`, `Unread`, `Reading`, `Stopped`. + Each `metadata.json` file correspond to a book, and there **must** be a cover named `cover.ext` in the same directory. Any extension works. -- cgit v1.2.3