aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2023-02-09 10:12:32 +0100
committerJoris2023-02-09 10:12:32 +0100
commit31acb6e43c07066e9a5ba404ea6c59201937c05a (patch)
tree0c2f2ee73585e0a9bfdcd8bd963c2f1a7263d987 /README.md
parent4e2339ddd1d95c07e7b54dee8565cd07e9e7dc34 (diff)
Complete documentation about reading status
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
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.