Merge pull request #283 from snshn/formatting

Format README.md and annotate workflows

.github/workflows/cd.yml

@@ -1,4 +1,4 @@
-# CD GitHub Actions workflow for Monolith
+# CD GitHub Actions workflow for monolith
 
 name: CD
 

.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+# CI GitHub Actions workflow for monolith
+
 name: CI
 
 on:

README.md

@@ -1,6 +1,6 @@
-[![Monolith Build Status for GNU/Linux](https://github.com/Y2Z/monolith/workflows/GNU%2FLinux/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AGNU%2FLinux)
-[![Monolith Build Status for macOS](https://github.com/Y2Z/monolith/workflows/macOS/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AmacOS)
-[![Monolith Build Status for Windows](https://github.com/Y2Z/monolith/workflows/Windows/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AWindows)
+[![monolith build status on GNU/Linux](https://github.com/Y2Z/monolith/workflows/GNU%2FLinux/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AGNU%2FLinux)
+[![monolith build status on macOS](https://github.com/Y2Z/monolith/workflows/macOS/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AmacOS)
+[![monolith build status on Windows](https://github.com/Y2Z/monolith/workflows/Windows/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AWindows)
 
 ```
  _____     ______________    __________      ___________________    ___
@@ -18,8 +18,10 @@ Unlike the conventional “Save page as”, `monolith` not only saves the target
 
 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
 
 #### Using [Cargo](https://crates.io/crates/monolith)
@@ -83,8 +85,10 @@ cd monolith
 make install
 ```
 
+
 ---------------------------------------------------
 
+
 ## Usage
 ```console
 monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html
@@ -94,8 +98,10 @@ or
 cat index.html | monolith -aIiFfcMv -b https://original.site/ - > result.html
 ```
 
+
 ---------------------------------------------------
 
+
 ## Options
  - `-a`: Exclude audio sources
  - `-b`: Use custom `base URL`
@@ -110,24 +116,30 @@ cat index.html | monolith -aIiFfcMv -b https://original.site/ - > result.html
  - `-k`: Accept invalid X.509 (TLS) certificates
  - `-M`: Don't add timestamp and URL information
  - `-n`: Extract contents of NOSCRIPT elements
- - `-o`: Write output to `file`, use “-” for STDOUT
+ - `-o`: Write output to `file` (use “-” for STDOUT)
  - `-s`: Be quiet
  - `-t`: Adjust `network request timeout`
  - `-u`: Provide custom `User-Agent`
  - `-v`: Exclude videos
 
+
 ---------------------------------------------------
 
+
 ## 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
@@ -135,14 +147,18 @@ Please open an issue if something is wrong, that helps make this project better.
  - Hako: https://github.com/dmpop/hako
  - Monk: https://gitlab.com/fisherdarling/monk
 
+
 ---------------------------------------------------
 
+
 ## License
 
 To the extent possible under law, the author(s) have dedicated all copyright related and neighboring rights to this software to the public domain worldwide.
 This software is distributed without any warranty.
 
+
 ---------------------------------------------------
 
+
 <!-- Microtext -->
 <sub>Keep in mind that `monolith` is not aware of your browser’s session</sub>