Skip to content

Commit

Permalink
docs: 📝 updated docs to reflect correct usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Disane87 committed Jul 13, 2023
1 parent 0c43faf commit fa3bab0
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- usage -->
```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
...

```
<!-- usagestop -->

Expand All @@ -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 <value>] [-c <value> -r]
$ npx docudigger scrape all [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l <value>] [-c <value> -r]
FLAGS
-c, --recurringCron=<value> [default: * * * * *] Cron pattern to execute periodically
Expand All @@ -96,7 +99,7 @@ Used to get invoices from amazon

```
USAGE
$ docudigger scrape amazon -u <value> -p <value> [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l
$ npx docudigger scrape amazon -u <value> -p <value> [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l
<value>] [-c <value> -r] [--fileDestinationFolder <value>] [--fileFallbackExentension <value>] [-t <value>]
[--yearFilter <value>] [--pageFilter <value>] [--onlyNew]
Expand Down

0 comments on commit fa3bab0

Please sign in to comment.