@ -19,15 +19,44 @@ Here is a before-and-after comparison, using [an article from The Guardian](http
## Installation
**readability-cli** can be installed on any system with [Node.js](https://nodejs.org/en/):
**readability-cli** can run via either [Node.js](https://nodejs.org/en/) or its newer and safer Rust counterpart [Deno](https://deno.land/).
### Node.js
Install the program and its man page:
`npm install -g readability-cli`
(Note to package maintainers: it might be a good idea to provide a symlink, so the man page can be accessed either as `readability-cli(1)` or as `readable(1)`.)
*(Note to package maintainers: it might be a good idea to provide a symlink, so the man page can be accessed either as `readability-cli(1)` or as `readable(1)`)*
### Deno
Deno support is still in development, running the script directly with `deno run <URL>` is not supported.
However, you can clone this Git repository and easily run the `readable.ts` script.
\fBreadability-cli\fR\- get useful text from a web page
.SHSYNOPSYS
@ -37,7 +37,7 @@ Don't sanitize HTML\.
\fB\-K\fP, \fB\-\-insecure\fP
.RS0
.IP\(bu2
Allow invalid SSL certificates\.
(Node\.js version only) Allow invalid SSL certificates\.
.RE
.P
@ -90,7 +90,7 @@ Output specific properties of the document (see \fBProperties\fR subsection)\.
\fB\-x\fP, \fB\-\-proxy\fP\fIURL\fR
.RS0
.IP\(bu2
Use specified proxy (can also use \fBHTTPS_PROXY\fP environment variable)\.
(Node\.js version only) Use specified proxy\. Node\.js and Deno can also use \fBHTTPS_PROXY\fP environment variable\.
.RE
.P
@ -201,7 +201,7 @@ T}
.P
\fBreadability\-cli\fR supports localization, using the environment variables \fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP and \fBLANGUAGE\fP, in that order\. Only one language at a time is supported\.
.P
\fBHTTPS_PROXY\fP will set the HTTPS proxy, as previously stated, however the \fB\-\-proxy\fP option overrides this\.Lowercase \fBhttps_proxy\fP and \fBhttp_proxy\fP are also recognized\.
\fBHTTPS_PROXY\fP will set the HTTPS proxy, as previously stated, however the \fB\-\-proxy\fP option overrides this\.Node\.js also recognizes lowercase \fBhttps_proxy\fP and \fBhttp_proxy\fP, for compatibility with \fBcurl\fP\|\.
.SHEXAMPLE
.P
\fBRead HTML from a file and output the result to the console:\fR