aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2023-09-12 22:45:16 +0200
committerJoris2023-09-12 22:45:16 +0200
commitc8ffa6722ef948879fa6ed9642ad134a2193fa4b (patch)
tree06742ecb6f838af6f0a44344505bd5fc11b24397 /README.md
parent941e8eb10c7e9cef883fbbc283f154f3312f0f9b (diff)
Write metadata in TOML
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 15 insertions, 13 deletions
diff --git a/README.md b/README.md
index 9130a59..9c530de 100644
--- a/README.md
+++ b/README.md
@@ -4,23 +4,25 @@ 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": "Read"
-}
+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"
```
`read` is one of: `Read`, `Unread`, `Reading`, `Stopped`.
-Each `metadata.json` file correspond to a book, and there **must** be a cover
+Each `metadata.toml` file correspond to a book, and there **must** be a cover
named `cover.ext` in the same directory. Any extension works.
## Show library