Documenting parameters
This commit is contained in:
parent
ddf74ba69c
commit
7a7fa49b90
10
README.md
10
README.md
|
@ -2,7 +2,7 @@ Status Embark plugin for MythX.
|
||||||
|
|
||||||
# QuickStart
|
# 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
|
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
|
# Options
|
||||||
|
|
||||||
`--full`, `-f` -- run full analysis instead of quick.
|
`--full`, `-f` -- run full analysis instead of quick.
|
||||||
`--debug`, `-d` -- print additional output.
|
`--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.
|
Loading…
Reference in New Issue