Skip to content

Commit

Permalink
Merge pull request #9 from privacybydesign/improve-docs
Browse files Browse the repository at this point in the history
Improve yivi-dummy pairing options documentation
  • Loading branch information
bobhageman authored Mar 27, 2023
2 parents da05c06 + 0571692 commit f18a10d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions plugins/yivi-dummy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ the `qrPayload` option.
If you want to customize what the Promise resolves to, you can pass anything to
the `successPayload` option.

### pairingCode

If you are testing the `pairing` dummy flow, a 4-digit pairing code is asked.
By default, this is `1234`, but you can change it by setting the `pairingCode`
option to a different value.

### timing

Finally, you can customize the timings of the different stages. Maybe you want
Expand All @@ -64,7 +70,9 @@ These are the defaults:
const yivi = new YiviCore({
timing: {
start: 1000,
prepare: 1000,
scan: 2000,
pairing: 500,
app: 2000
}
});
Expand Down

0 comments on commit f18a10d

Please sign in to comment.