From a92bba4ec52867b29a77e0a7d92c1c38965fe58a Mon Sep 17 00:00:00 2001 From: Sunshine Date: Thu, 5 Mar 2020 05:15:13 -0500 Subject: [PATCH] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 4ee8ccc..010da95 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Unlike the conventional "Save page as", `monolith` not only saves the target doc If compared to saving websites with `wget -mpk`, this tool embeds all assets as data URLs and therefore lets browsers render the saved page exactly the way it was on the Internet, even when no network connection is available. +--------------------------------------------------- ## Installation @@ -34,10 +35,12 @@ If compared to saving websites with `wget -mpk`, this tool embeds all assets as #### Via Docker The guide can be found [here](https://github.com/Y2Z/monolith/wiki/Using-containers) +--------------------------------------------------- ## Usage $ monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html +--------------------------------------------------- ## Options - `-c`: Ignore styles @@ -51,24 +54,29 @@ The guide can be found [here](https://github.com/Y2Z/monolith/wiki/Using-contain - `-t`: Set custom network request timeout - `-u`: Provide own User-Agent +--------------------------------------------------- ## HTTPS and HTTP proxies Please set `https_proxy`, `http_proxy`, and `no_proxy` environment variables. +--------------------------------------------------- ## Contributing Please open an issue if something is wrong, that helps make this project better. +--------------------------------------------------- ## Related projects - `Monolith Chrome Extension`: https://github.com/rhysd/monolith-of-web - `Pagesaver`: https://github.com/distributed-mind/pagesaver - `Personal WayBack Machine`: https://github.com/popey/pwbm +--------------------------------------------------- ## License The Unlicense +--------------------------------------------------- Keep in mind that `monolith` is not aware of your browser's session