Documenting parameters

This commit is contained in:
Sebastian Mueller 2019-04-22 23:46:52 +02:00
parent ddf74ba69c
commit 7a7fa49b90
1 changed files with 9 additions and 1 deletions

View File

@ -2,7 +2,7 @@ Status Embark plugin for MythX.
# QuickStart
Run `verify` in the Embark console. When the call returns, it will look something like this:
Run `verify [options] [contracts]` in the Embark console. When the call returns, it will look something like this:
```
Embark (development) > verify
@ -32,7 +32,15 @@ Add `embark-mythx` to the `plugins` section in your `embark.json`. To have the p
}
```
# Parameters
`contracts` (optional) -- List of contracts to submit.
# Options
`--full`, `-f` -- run full analysis instead of quick.
`--debug`, `-d` -- print additional output.
`no-cache-lookup`, `-c` -- Resubmit contracts, ignore cached results.
`limit`, `-l` -- Number of analyses submitted at a time.
`initial-delay`, `-i` -- Time before first status request.