Skip to content

Add sequence diagram to README for digital wallet process #12

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

Open
namelessmasses wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add sequence diagram to README for digital wallet process #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 21 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,25 @@ digital wallet.

![image](https://github.com/stateofca/opencred/assets/108611/ace09a1c-a409-4371-81cf-ea578a2fea1e)

```mermaid
sequenceDiagram
Participant Wallet as Digital Wallet
Actor User as User
participant Browser as Web Browser
Participant Website as Your Website
Participant OpenCred

User ->> Browser: Visit your website
Browser ->> Website: Initiate user verification process
Website ->> OpenCred: Generate QR code
OpenCred ->> Browser: Display QR code
%%Browser -->> User: ;
User ->> Wallet: Scan QR Code
Wallet ->> OpenCred: Present digital credential
OpenCred ->> OpenCred: Verify digital credential
OpenCred ->> Website: return verified data
```

## Features

OpenCred supports the following list of features:
Expand All @@ -38,7 +57,7 @@ OpenCred supports the following list of features:

### Configuration

The app is configured via a YAML file compatible with
The app is configured via a YAML file compatible with
[@bedrock/config-yaml](https://www.npmjs.com/package/@bedrock/config-yaml). See
[configs/combined.example.yaml](configs/combined.example.yaml) for an example.

Expand All @@ -63,7 +82,7 @@ If you're using VS Code as your editing environment, you can install an
extension and configure automatic schema validation for your `combined.yaml`
file. This will provide you with real-time feedback as you type in your
configuration file. Errors on missing required properties, descriptions and
example values for configuration fields, auto-complete of fields are supported.
example values for configuration fields, auto-complete of fields are supported.

To configure your VS Code workspace to use auto-completion, install the plugin
[redhat.vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
Expand Down