Skip to content

Commit 6480a28

Browse files
committed
docs: update README and CHANGELOG for v0.2.2
1 parent 1d68a41 commit 6480a28

2 files changed

Lines changed: 149 additions & 68 deletions

File tree

CHANGELOG.md

Lines changed: 58 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,91 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
3+
All notable changes to this project are documented in this file.
44

5-
This project follows Semantic Versioning.
5+
This project follows [Semantic Versioning](https://semver.org/).
66

77
---
88

99
## [0.2.2] - 2026-03-02
1010

11+
Published: 2026-03-02T14:07:04Z
12+
1113
### Changed
1214

1315
- Session storage key standardized to `"vex-session"`.
14-
- Login identity request now stores compact app info keys:
15-
- `pi` (peer id), `na` (app name), `ic` (icon), `do` (origin), optional `auth` (cached proof).
16-
- Request method names standardized:
17-
- `signRequest`, `signMessage`, `sharedSecret`.
16+
- Login identity payload compacted with standardized keys:
17+
- `pi` (peer id)
18+
- `na` (app name)
19+
- `ic` (icon)
20+
- `do` (origin)
21+
- optional `auth` (cached identity proof)
22+
- RPC method names standardized:
23+
- `signRequest`
24+
- `signMessage`
25+
- `sharedSecret`
1826

1927
### Added
2028

21-
- `clearSession()` helper.
22-
- Session reuse:
23-
- Reuses saved `peerID` and hints (`account@permission`) when present.
29+
- `clearSession()` helper for manual session reset.
30+
- Smart session reuse:
31+
- Reuses stored `peerID`
32+
- Reuses permission hints (`account@permission`) when available.
2433

2534
### Fixed
2635

27-
- Safer session loading (auto-clears invalid or expired payloads).
28-
- Improved cleanup on disconnect (best-effort destroy/disconnect).
36+
- Hardened session loader:
37+
- Automatically clears expired or malformed session payloads.
38+
- Improved disconnect cleanup:
39+
- Safe destroy/disconnect (best-effort, non-throwing).
2940

3041
### Improved
3142

32-
- Low-memory friendly behavior:
33-
- Lightweight heartbeat/ping with jitter (best-effort).
34-
- Minimal allocations on message routing.
43+
- Optimized for low-memory environments:
44+
- Lightweight heartbeat with jitter
45+
- Reduced message routing allocations
46+
- Lower background CPU usage on mobile devices
3547

3648
---
3749

38-
## [0.2.1]
50+
## [0.2.1] - 2025-10-13
51+
52+
Published: 2025-10-13T16:28:38Z
3953

4054
### Added
4155

42-
- Initial PeerJS signaling support.
43-
- Session persistence via sessionStorage.
44-
- Transaction signing via VSR.
45-
- Message signing.
46-
- Shared secret (ECDH).
56+
- PeerJS signaling support.
57+
- Session persistence via `sessionStorage`.
58+
- Transaction signing via Vexanium Signing Request (VSR).
59+
- Message signing support.
60+
- Shared secret derivation (ECDH).
4761

4862
---
4963

50-
## [0.1.1]
64+
## [0.2.0] - 2025-10-06
65+
66+
Published: 2025-10-06T14:44:23Z
67+
68+
### Added
69+
70+
- Structured WebRTC connection lifecycle.
71+
- WalletSession abstraction layer.
72+
- Basic login flow via embedded PeerID inside VSR.
73+
- Request/response routing via internal request IDs.
74+
75+
### Improved
76+
77+
- More predictable session initialization flow.
78+
- Internal protocol normalization groundwork.
79+
80+
---
81+
82+
## [0.1.1] - 2025-08-12
83+
84+
Published: 2025-08-12T01:33:25Z
5185

5286
### Added
5387

5488
- Initial public release of WindKit.
89+
- Basic VSR identity login.
90+
- WebRTC DataConnection integration.
91+
- Minimal transaction signing flow.

0 commit comments

Comments
 (0)