SinTan1729/recipe-box-for-wikijs
1
0
Fork 0
mirror of https://github.com/SinTan1729/recipe-box-for-wikijs.git synced 2024-12-24 17:38:37 -06:00
Code Issues Projects Releases Packages Wiki Activity

docs: Updated README

Browse source
This commit is contained in:
Sayantan Santra 2023-07-06 01:43:49 -05:00
parent 52bf04e399
commit 1b2807ddd2
Signed by: SinTan1729
GPG key ID: EB3E68BFBA25C85F
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -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.