From aafa10d874efb49a997ec679a88a1699cfea3a6f Mon Sep 17 00:00:00 2001
From: Domenic Denicola <d@domenic.me>
Date: Wed, 1 Jul 2020 17:04:58 -0400
Subject: [PATCH] Update the documentation

---
 README.md    | 20 ++++++++++++++++----
 package.json |  3 ++-
 2 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 86c2e90..1072b4c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # _Worm_ Scraper
 
-Scrapes the web serial [_Worm_](https://parahumans.wordpress.com/) into an eBook format.
+Scrapes the web serial [_Worm_](https://parahumans.wordpress.com/) and its sequel [_Ward_](https://www.parahumans.net/) into an eBook format.
 
 ## How to use
 
@@ -8,26 +8,38 @@ First you'll need a modern version of [Node.js](https://nodejs.org/en/). Install
 
 Then, open a terminal ([Mac documentation](http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line), [Windows documentation](http://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/)) and install the program by typing
 
-```
+```bash
 npm install -g worm-scraper
 ```
 
 This will take a while as it downloads this program and its dependencies from the internet. Once it's done, try to run it, by typing:
 
-```
+```bash
 worm-scraper --help
 ```
 
 If this outputs some help documentation, then the installation process went smoothly. You can move on to assemble the eBook by typing
 
-```
+```bash
 worm-scraper download convert scaffold zip
 ```
 
 This will take a while, but will eventually produce a `Worm.epub` file!
 
+If you'd like to get _Ward_ instead of _Worm_, use `--book=ward`, e.g.
+
+```bash
+worm-scraper download convert scaffold zip --book=ward
+```
+
 ## EPUB vs. other formats
 
 EPUB is one of the primary eBook formats, but it is not recognized by all readers, including most Amazon Kindle devices. You can use an online converter or other tool to convert EPUB to Kindle MOBI, or any other format.
 
 Alternately, if you are a developer, a pull request adding support for MOBI output would be appreciated; please open an issue to discuss how you plan to proceed.
+
+## Text fixups
+
+This project makes a lot of fixups to the original text, mostly around typos, punctuation, capitalization, and consistency. You can get a more specific idea of what these are via the code; there's [`convert.js`](https://github.com/domenic/worm-scraper/blob/master/lib/convert.js), where some things are handled generally, and [`substitutions.json`](https://github.com/domenic/worm-scraper/blob/master/lib/substitutions.json), for one-off fixes.
+
+This process is designed to be extensible, so if you notice any problems with the original text that you think should be fixed, file an issue to let me know, and we can update the fixup code so that the resulting eBook is improved. (Or better yet, send a pull request!)
diff --git a/package.json b/package.json
index 145bf49..8a87b3c 100644
--- a/package.json
+++ b/package.json
@@ -1,9 +1,10 @@
 {
   "name": "worm-scraper",
-  "description": "Scrapes the web serial Worm into an eBook format",
+  "description": "Scrapes the web serial Worm and its sequel Ward into an eBook format",
   "keywords": [
     "ebook",
     "worm",
+    "ward",
     "parahuman",
     "scraper"
   ],