From fa3bab0ef37324155ce13997915c96b9d7553564 Mon Sep 17 00:00:00 2001 From: Marco Franke Date: Thu, 13 Jul 2023 10:48:11 +0200 Subject: [PATCH] docs: :memo: updated docs to reflect correct usage --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9d4c0958..644f0139 100644 --- a/README.md +++ b/README.md @@ -45,21 +45,24 @@ All settings can be changed via `CLI`, env variable (even when using docker). ## Install -```sh -npm install -``` +> :warning: **Attention**: There is no need to install this locally. Just use `npx` + ## Usage +:memo: **Attention**: Make sure you have an `.env` file present (with the variables from above) in the work directory or use the appropriate cli arguments. + ```sh-session -$ npm install -g @disane-dev/docudigger -$ docudigger COMMAND + +$ npx docudigger COMMAND running command... -$ docudigger (--version) + +$ npx docudigger (--version) @disane-dev/docudigger/2.0.2 linux-x64 node-v18.16.1 -$ docudigger --help [COMMAND] + +$ npx docudigger --help [COMMAND] USAGE $ docudigger COMMAND -... + ``` @@ -69,7 +72,7 @@ Scrapes all websites periodically (default for docker environment) ``` USAGE - $ docudigger scrape all [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l ] [-c -r] + $ npx docudigger scrape all [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l ] [-c -r] FLAGS -c, --recurringCron= [default: * * * * *] Cron pattern to execute periodically @@ -96,7 +99,7 @@ Used to get invoices from amazon ``` USAGE - $ docudigger scrape amazon -u -p [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l + $ npx docudigger scrape amazon -u -p [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l ] [-c -r] [--fileDestinationFolder ] [--fileFallbackExentension ] [-t ] [--yearFilter ] [--pageFilter ] [--onlyNew]