update README.md
This commit is contained in:
parent
d5808ff535
commit
16f39a3f5c
25
README.md
25
README.md
|
@ -26,7 +26,13 @@ git clone https://tildegit.org/exquisitecorp/bookmobile.git
|
|||
|
||||
### Usage
|
||||
|
||||
By default bookmobile will save the article to the current directory as a simple HTML document.
|
||||
By default bookmobile will download the specified url and save to the current directory as a simplified html document with *readability*.
|
||||
|
||||
```
|
||||
./bookmobile http://article.url
|
||||
```
|
||||
|
||||
Additional options available:
|
||||
|
||||
```
|
||||
Bookmobile: Simple command line script to download articles for offline reading as html, epub or markdown. Saves a simplified html document to current directory as default.
|
||||
|
@ -34,7 +40,7 @@ Bookmobile: Simple command line script to download articles for offline reading
|
|||
Optionally, you can specify a theme, format and output directory
|
||||
|
||||
Usage: ./bookmobile url [ --theme THEME ] [ --format FORMAT ] [ --output OUTPUT ]
|
||||
[-h | --help ]
|
||||
[-h | --help ]
|
||||
|
||||
Options:
|
||||
|
||||
|
@ -44,12 +50,11 @@ Options:
|
|||
--theme THEME
|
||||
-t THEME Set theme for reader format. Default: medium
|
||||
Theme options:
|
||||
github
|
||||
gmi
|
||||
medium
|
||||
now
|
||||
pandoc
|
||||
sakura
|
||||
github
|
||||
gmi
|
||||
medium
|
||||
now
|
||||
pandoc
|
||||
|
||||
--format FORMAT
|
||||
-f FORMAT Set file format (html, reader, markdown, epub)
|
||||
|
@ -58,9 +63,10 @@ sakura
|
|||
--output OUTPUT
|
||||
-o OUTPUT Set output location
|
||||
default: current directory
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
### To add themes
|
||||
|
||||
|
@ -72,7 +78,6 @@ Currently there are a number of CLI programs that are ports of the Readability p
|
|||
|
||||
A partial listing can be found [here](https://github.com/masukomi/arc90-readability#readability-10)
|
||||
|
||||
|
||||
### Contributing
|
||||
|
||||
Polite issues and pull requests will be considered!
|
||||
|
|
Loading…
Reference in New Issue