Skip to content

Commit 2e00296

Browse files
rhyslbwclaude
andcommitted
docs: add docs/README index linking the security audits
Adds a root docs/README.md pointing to the dependency vulnerability audit (docs/security/) and the in-package crypto audit (packages/crypto/AUDIT.md), so both are discoverable from one place without moving the crypto audit out of its package (keeps its README link valid on npm). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 7af455a commit 2e00296

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Documentation
2+
3+
Tracked, human-authored documentation for the Cardano JS SDK. (Generated API
4+
reference is produced by TypeDoc into `typedoc/` and published separately.)
5+
6+
## Security
7+
8+
- [Dependency vulnerability audit (2026-06-19)](./security/dependency-vulnerability-audit-2026-06-19.md)
9+
point-in-time audit of the dependency remediation: per-dependency vulnerability status,
10+
blast radius across SDK packages, and supply-chain provenance.
11+
- [Crypto package security audit (Nov 2023)](../packages/crypto/AUDIT.md)
12+
third-party audit of the `@cardano-sdk/crypto` libsodium implementation
13+
([PDF report](../packages/crypto/audit_202311.pdf)). Kept inside the package so its
14+
link remains valid when the README is rendered on npm.

0 commit comments

Comments
 (0)