diff --git a/README.md b/README.md index b2a7e0c..d755286 100644 --- a/README.md +++ b/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] +``` +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.