Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BioPhoton authored Apr 10, 2022
1 parent 4ccfdc4 commit 728ade3
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,15 +215,16 @@ This command executes a set of user-flow definitions against the target URL and

Use the `.user-flowrc.json` propertiy `persist.format` and give an array as value. e.g. `['html']` or `['html', 'json']`.

You can also use use the CLI option `--format` to choose a format.
You can also use use the CLI option `--format` to choose a format.

For a single format run: `@push-based/user-flow collect --format html` and
for multiple formats `@push-based/user-flow collect --format html --format json`.

You can either export the report as `HTML` or `JSON` format. The html file can be opened in any browser.
The json file can be drag & dropped into the [lighthouse viewer](https://googlechrome.github.io/lighthouse/viewer/).
This format is very good for programmatic processing and foundation for most of the features of this lib.

[![Lighhouse Viewer - FiledDrop area]()]
![Lighhouse Viewer - FiledDrop area](https://user-images.githubusercontent.com/10064416/162604365-31b4a9c9-c7cb-4654-a605-cecaeb2fb54f.PNG)

## Debugging

Expand Down

0 comments on commit 728ade3

Please sign in to comment.