Author: Honza Pokorny <honza@redhat.com>
Add readme
README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..daf915b456caad00eda5cad10f1724eab5850976 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +bookends +======== + +``` +Usage: + bookends [flags] + bookends [command] + +Available Commands: + build + cache + help Help about any command + +Flags: + --book-log-filename string (default "book-log.org") + --cache-dir string (default "cache") + --covers-dir string (default "covers") + -h, --help help for bookends + --output-filename string (default "output.html") + +Use "bookends [command] --help" for more information about a command. +``` + +Input format +------------ + +```org +#+title: Book Log + +* 2021 +** DONE Gentle and Lowly :theology: +CLOSED: [2021-07-04 Sun 16:02] +:PROPERTIES: +:AUTHOR: Dane C. Ortlund +:rating: 3 +:isbn: 1433566133 +:END: +``` + +Book covers +----------- + +Bookends uses ISBN information for retrieving a book's cover. It downloads it +to the cache directory. If your book's cover isn't available in the Open +Library, you can supply a file yourself. Place it in the covers directory, and +name it `<isbn>.jpg`. + +License +------- + +GPLv3 +