-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
32 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,33 @@ | ||
# _Worm_ Scraper | ||
|
||
Scrapes the web serial [_Worm_](https://parahumans.wordpress.com/) into an ebook format. | ||
Scrapes the web serial [_Worm_](https://parahumans.wordpress.com/) into an eBook format. | ||
|
||
Install globally and run `worm-scraper --help` for usage. | ||
## How to use | ||
|
||
First you'll need a modern version of [Node.js](https://nodejs.org/en/). Install whatever is current (not LTS). | ||
|
||
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 | ||
|
||
``` | ||
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: | ||
|
||
``` | ||
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 | ||
|
||
``` | ||
worm-scraper download convert scaffold zip | ||
``` | ||
|
||
This will take a while, but will eventually produce a `Worm.epub` file! | ||
|
||
## 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "worm-scraper", | ||
"description": "Scrapes the web serial Worm into an ebook format", | ||
"description": "Scrapes the web serial Worm into an eBook format", | ||
"keywords": [ | ||
"ebook", | ||
"worm", | ||
|
@@ -11,7 +11,7 @@ | |
"author": "Domenic Denicola <[email protected]> (https://domenic.me/)", | ||
"license": "WTFPL", | ||
"repository": "domenic/worm-scraper", | ||
"main": "lib/worm-scraper.js", | ||
"bin": "lib/worm-scraper.js", | ||
"files": [ | ||
"lib/", | ||
"scaffolding/" | ||
|