mirror of
https://github.com/SinTan1729/recipe-box-for-wikijs.git
synced 2024-12-25 09:48:36 -06:00
docs: Updated README
This commit is contained in:
parent
52bf04e399
commit
1b2807ddd2
1 changed files with 17 additions and 1 deletions
18
README.md
18
README.md
|
@ -3,4 +3,20 @@
|
|||
This is a fork of [lcordier/recipe_box](https://github.com/lcordier/recipe_box) modified to
|
||||
directly output files suitable for my Wiki.js instance.
|
||||
|
||||
For usage, info etc., please take a look at the upstream.
|
||||
## Installation
|
||||
```bash
|
||||
pipx install git+https://github.com/SinTan1729/recipe-box-for-wikijs
|
||||
```
|
||||
|
||||
## Usage
|
||||
```bash
|
||||
recipe_box [options] <list-of-links>
|
||||
```
|
||||
Available options:
|
||||
```bash
|
||||
-l : List all available sites
|
||||
-w : Enable wild mode. This tries to scrape from unsupported sites.
|
||||
-v : More verbose output.
|
||||
```
|
||||
|
||||
For more information, please take a look at the upstream.
|
||||
|
|
Loading…
Reference in a new issue