Skip to content

Commit bed4b9d

Browse files
committed
Add basic README with developer mode overview.
Documents the package as a library consumed by a host Bedrock app, the `initialize()` entry point, and a Developer Mode section (marked planned) linking to the spec.
1 parent fd60b62 commit bed4b9d

1 file changed

Lines changed: 44 additions & 1 deletion

File tree

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
1-
# bedrock-vue-wallet
1+
# bedrock-vue-wallet
2+
3+
Vue 3 + Quasar UI components for a Bedrock-based digital credential wallet.
4+
Stores and shares [Verifiable Credentials][] and drives credential exchanges
5+
(OID4VCI, OID4VP, and CHAPI).
6+
7+
## Usage
8+
9+
This package is a **library**, not a runnable application. It is published as
10+
`@bedrock/vue-wallet` and consumed by a host Bedrock web app, which provides the
11+
backend (sessions, KMS, credential store) and the peer dependencies listed in
12+
`package.json` (`vue`, `vue-router`, `@bedrock/quasar`, `@bedrock/web-wallet`,
13+
etc.).
14+
15+
The host app wires the wallet in via the `initialize()` export:
16+
17+
```js
18+
import {initialize} from '@bedrock/vue-wallet';
19+
20+
await initialize({app, router /*, features, quasarOptions */});
21+
```
22+
23+
## Developer Mode (planned)
24+
25+
> Status: **specified, not yet implemented.** See
26+
> [`docs/dev-mode-spec.md`](./docs/dev-mode-spec.md).
27+
28+
A developer-only UI overlay for desktop development, where camera hardware and
29+
live issuers / relying parties are unavailable. It lets a developer drive wallet
30+
flows by hand instead of scanning QR codes and running real exchanges.
31+
32+
- **Enable:** set a truthy `localStorage` flag `wallet.devMode` (e.g. in
33+
DevTools: `localStorage.setItem('wallet.devMode', '1')`). Off by default; the
34+
trigger is never installed in normal use, so production behavior is unchanged.
35+
- **Open the panel:** press backtick (`` ` ``) three times in quick succession.
36+
- **Tools:**
37+
- **Paste exchange URL** — paste an `https:` (`iuv=1`),
38+
`openid-credential-offer:`, or `openid4vp:` URL instead of scanning a QR
39+
code; it is fed into the existing scanner exchange pipeline.
40+
- **Seed test credentials** — once logged in, populate the dashboard with
41+
synthetic credentials so credential display/management UIs can be developed
42+
without running a full exchange.
43+
44+
[Verifiable Credentials]: https://www.w3.org/TR/vc-data-model-2.0/

0 commit comments

Comments
 (0)