diff --git a/README.md b/README.md index 0ae80f6..2b27615 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,19 @@ # Bookmobile -Command line software written in fishscript (shell), for saving articles for offline viewing as epubs, markdown and in a simple reader view webpage. +Simple command line script to download articles for offline viewing as markdown, simplified clean HTML and epub. -This software is currently in-progress. Expect some warts. +This is a fishscript (shell) gluing together pandoc and a Node.js package that implements the Firefox reader view. It uses a NPM package that uses Mozilla's own reability javascript. If that's not the right solution for you, jump down to the alternatives section at the end. + +### Dependencies + +- fish +- Pandoc +- Node.js / NPM ### Install ``` +npm install readability-cli git clone https://tildegit.org/exquisitecorp/bookmobile.git cd bookmobile chmod +x bookmobile.fish @@ -18,17 +25,13 @@ chmod +x bookmobile.fish ./bookmobile.fish URL ``` -The original URL article's HTML will be saved to originals. An epub, markdown, and a simplified reader view will be placed in their respective folders. +Output: -### Dependencies +A simplified HTML document will be saved to originals. A reader view with chosen (or default) theme will be saved to reader/. An epub in epubs/ and a markdown file to markdown sub-directory. -- fish -- Pandoc>2.0 -- Lua -- wget +### To change themes -### TODO -- [ ] Clean up reader view - strip out as much cruft (headers, footers) as possible +The themes subdirectory contains several custom simple themes for rendering a nice reader view. You can edit these or add your own custom theme to this folder. Change the theme selection in line 3 of the bookmobile.fish file. ### Alternatives