diff --git a/README.md b/README.md index 2c5f0ae..538f458 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,52 @@ # reader-view-cli -**Firefox Reader View in your terminal!** +#### 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. +**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, and other uses. ### An example of Reader View in Firefox: -**Standard view in Firefox** +#### Standard view ![An article from The Guardian with standard view in Firefox](https://i.imgur.com/6xyyShd.png "Standard view in Firefox") -**Reader View in Firefox** +#### Reader View ![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: +### An example of reader-view-cli with W3M browser: -**Standard view in W3M** +#### Standard view ![An article from The Guardian in W3M](https://i.imgur.com/kAeCfh1.png "Standard view in W3M") -**reader-view-cli + W3M** +#### reader-view-cli ![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 PROPS... Output specific properties of the parsed article - -V --version Print version - -u --url Set the document URL when parsing standard input or a local file (this affects relative links and such) - -U --is-url Interpret SOURCE as a URL rather than file name - -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