diff --git a/README.md b/README.md new file mode 100644 index 0000000..de77dae --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# reader-view-cli + +**Firefox Reader View in your terminal!** + +**reader-view-cli** takes any HTML page and strips out unnecessary bloat by using [Mozilla's Readability library](https://github.com/mozilla/readability). As a result, you get a web page which contains only the core content and nothing more. The resulting HTML is suitable for terminal browsers, text readers, or perhaps other use-cases. + +### An example of Reader View in Firefox: + +**Standard view in Firefox** + +![An article from The Guardian with standard view in Firefox](https://i.imgur.com/6xyyShd.png "Standard view in Firefox") + +**Reader View in Firefox** + +![An article from The Guardian with Reader View in Firefox](https://i.imgur.com/V27OUch.png "Reader View in Firefox") + +#### An example of reader-view-cli with W3M browser: + +**Standard view in W3M** + +![An article from The Guardian in W3M](https://i.imgur.com/kAeCfh1.png "Standard view in W3M") + +**reader-view-cli + W3M** + +![An article from The Guardian in W3M using reader-view-cli](https://i.imgur.com/KaSY1JS.png "reader-view-cli with W3M") + +## Usage + +`readable [SOURCE] [options]` +`readable [options] -- [SOURCE]` +(where SOURCE is a file, an http(s) URL, or '-' for standard input) + +Options: +``` + --help Print help + -o --output OUTPUT_FILE Output to OUTPUT_FILE + -p --properties PROP1,[PROP2,...] Output specific properties of the parsed article + -V --version Print version + -u --url Interpret SOURCE as a URL + -q --quiet Don't output extra information to stderr +``` + +The --properties option accepts a comma-separated list of values (with no spaces in-between). Suitable values are: +``` + html-title Outputs the article's title, wrapped in an