diff --git a/README.md b/README.md index 0820ea8..7066786 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ fimfic2epub This is a tool to generate better EPUB ebooks from [fimfiction](https://fimfiction.net/) stories. It's also a Chrome/Firefox extension, replacing the default EPUB download option with this tool. -[Screenshot](http://i.imgbox.com/MalEBiuC.png) of Chrome extension +[Screenshot](http://i.imgbox.com/MalEBiuC.png) of the Chrome extension Demo ---- @@ -14,18 +14,17 @@ You can have a look at what a generated EPUB looks like [here](http://books.djaz Usage (browser extension) ----------------- - You can download the Chome extension from [Chrome Web Store](https://chrome.google.com/webstore/detail/fimfic2epub/fiijkoniocipeemlflajmmaecfhfcand) and [Firefox Add-ons](https://addons.mozilla.org/firefox/addon/fimfic2epub/) Installation & usage (command line) ------------------- - You can install the tool by running `npm install -g fimfic2epub`. You can then run it like this: `$ fimfic2epub []` -By default the EPUB will be saved in the current working directory with the filename `Title by Author.epub`. You can set filename to `-` and the epub will be emitted to stdout instead. +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. + Examples -------- @@ -42,13 +41,11 @@ $ fimfic2epub 180690 - > path/to/file.epub Building -------- - Make sure [Node.js](https://nodejs.org) is installed. After you've cloned this repository, run `npm install` and `npm run build` to build it. This project uses [gulp](http://gulpjs.com/). Run `npm run dev` for a quicker development build. You can add `watch` to both for automatic rebuilding. Development ----------- - Make sure [gulp is installed](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md). When working on the code and testing it in a web browser as an extension, you can run gulp in watch mode: `gulp watch`. This will lint code and build it when you save. To build, just run `gulp` or `npm run build`. To lint, run `gulp lint` and to clean, run `gulp clean`. diff --git a/bin/fimfic2epub b/bin/fimfic2epub index 2c3728a..6ebb533 100755 --- a/bin/fimfic2epub +++ b/bin/fimfic2epub @@ -1,34 +1,76 @@ #!/usr/bin/env node +const args = require('commander') + .command('fimfic2epub [filename]') + .description(require('../package.json').description) + .version(require('../package.json').version) + .option('-t, --title ', 'Set the title of the story') + .option('-a, --author ', 'Set the author of the story') + .option('-c, --no-comments-link', 'Don\'t add link to online comments') + .option('-h, --no-headings', 'Don\'t add headings to chapters') + .option('-e, --no-external', 'Don\'t embed external resources, such as images (breaks EPUB spec)') + .option('-n, --no-notes', 'Don\'t include author notes') + .option('-i, --notes-index', 'Create an index with all author notes at the end of the ebook') + .option('-p, --paragraphs