Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve yivi-dummy pairing options documentation #9

Merged
merged 2 commits into from
Mar 27, 2023
Merged

Improve yivi-dummy pairing options documentation #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f63d19c
Improve yivi-dummy pairing options documentation
bobhageman Mar 23, 2023
0571692
Merge branch 'master' into improve-docs
ivard Mar 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions plugins/yivi-dummy/README.md
View file
Open in desktop
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