diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 15 insertions, 13 deletions
@@ -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 |