update README.md

This commit is contained in:
lee2sman 2021-07-20 17:23:41 -04:00
parent 8453232128
commit 1231a910d6
1 changed files with 31 additions and 0 deletions

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# Bookmobile
Command line software written in fishscript (shell), for saving articles for offline viewing as epubs, markdown and in a simple reader view webpage.
This software is currently in-progress. Expect some warts.
### Install
```
git clone https://tildegit.org/exquisitecorp/bookmobile.git
cd bookmobile
chmod +x bookmobile.fish
```
### Usage
```
./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.
### Dependencies
- fish
- Pandoc>2.0
- Lua
- wget
### TODO
- [ ] Clean up reader view - strip out as much cruft (headers, footers) as possible