Skip to content

Commit aa7002b

Browse files
committed
docs(README): minor updates to README.md
1 parent f09fb12 commit aa7002b

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -125,18 +125,25 @@ Genesis (tmb) ──pre──▶ key/create ──pre──▶ key/revoke
125125
```
126126
Cyphr/
127127
├── SPEC.md # Full protocol specification
128-
├── docs/ # Plans, models, ADRs
129-
├── go/ # Go implementation
128+
├── docs/ # Documentation and planning
129+
│ ├── sites/blog/ # blog.cyphr.me source
130+
│ ├── sites/docs/ # docs.cyphr.me source
131+
│ └── ... # Plans, models, charters
132+
├── go/ # Go implementation (flat package)
133+
│ ├── storage/ # Storage backends
134+
│ ├── testfixtures/ # Test fixture loading
130135
│ └── README.md # Go-specific documentation
131136
├── rs/ # Rust implementation
132137
│ ├── cyphr/ # Core crate
133138
│ ├── cyphr-storage/ # Storage crate
134139
│ ├── cyphr-cli/ # CLI binary
135-
│ ├── malt/ # Merkle Append-only Log Tree
140+
│ ├── fixture-gen/ # Golden fixture generation
141+
│ ├── test-fixtures/ # Golden fixture definitions
136142
│ └── README.md # Rust-specific documentation
137-
├── tests/ # Language-agnostic test fixtures
138-
│ ├── golden/ # Pre-computed golden fixtures (47 tests)
139-
│ ├── e2e/ # E2E intent files (5 scenarios)
143+
├── tests/ # Language-agnostic test vectors
144+
│ ├── golden/ # Pre-computed golden fixtures
145+
│ ├── e2e/ # E2E scenario files
146+
│ ├── intents/ # Intent definitions per category
140147
│ └── README.md # Test fixture documentation
141148
```
142149

@@ -151,12 +158,15 @@ Both implementations support Levels 1-4 (single key through authenticated action
151158

152159
All tests pass using shared language-agnostic test vectors.
153160

154-
## Built On Coz
161+
## Built On
155162

156-
Cyphr uses [Coz](https://github.com/Cyphrme/Coz) for all cryptographic operations. Coz is a JSON messaging specification supporting ES256, ES384, ES512, and Ed25519.
163+
- **[Coz](https://github.com/Cyphrme/Coz)** — Cryptographic JSON messaging (ES256, ES384, ES512, Ed25519)
164+
- **[MALT](https://github.com/Cyphrme/malt)** — Merkle Append-only Log Tree
157165

158166
## Documentation
159167

168+
- **[docs.cyphr.me](https://docs.cyphr.me)** — Getting started guides, CLI reference, and glossary
169+
- **[blog.cyphr.me](https://blog.cyphr.me)** — Project blog
160170
- **[SPEC.md](SPEC.md)** — Full protocol specification
161171
- **[go/README.md](go/README.md)** — Go implementation guide
162172
- **[rs/README.md](rs/README.md)** — Rust implementation guide

0 commit comments

Comments
 (0)