From 6a461904d4b157f3401bb963d35df53b801cef26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20J=C3=B6nsson?= Date: Wed, 14 Mar 2018 09:45:27 +0100 Subject: [PATCH] Add help to readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae2ead1..8132ff5 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,30 @@ You can install the tool by running `npm install -g fimfic2epub`. You can then r `$ fimfic2epub []` -By default the EPUB will be saved in the current working directory with the filename `Title by Author.epub`. Run `fimfic2epub --help` to see a list of all flags. +By default the EPUB will be saved in the current working directory with the filename `Title by Author.epub`. Run `fimfic2epub -h` to see a list of all flags. +``` + Usage: fimfic2epub [options] [filename] + + Tool to generate improved EPUB ebooks from Fimfiction stories + + Options: + + -V, --version output the version number + -d, --dir Directory to store ebook in. Is prepended to filename + -t, --title Set the title of the story + -a, --author Set the author of the story + -c, --no-comments-link Don't add link to online comments + -H, --no-headings Don't add headings to chapters + -e, --no-external Don't embed external resources, such as images (breaks EPUB spec) + -n, --no-notes Don't include author notes + -i, --notes-index Create an index with all author notes at the end of the ebook + -p, --paragraphs