Skip to content

Commit a040db9

Browse files
Update README.md
1 parent f9b4f9b commit a040db9

File tree

1 file changed

+54
-76
lines changed

1 file changed

+54
-76
lines changed

README.md

Lines changed: 54 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -160,104 +160,82 @@ This makes the system transparent, auditable, and privacy-first by design.
160160

161161

162162

163-
### Keywords & Topics
163+
## Keywords & Topics
164164

165-
**PAXECT Core** — deterministic multi-channel **.freq v42** container with **CRC32 integrity**, **AES-GCM/CTR security**, **cross-OS polyglot bridges**, and **Zero-AI SelfTune**.
165+
**PAXECT Core** — deterministic multi-channel **.freq v42** container with **CRC32** integrity, **AES-GCM/CTR** security, cross-OS **Polyglot** bridges, and **Zero-AI SelfTune**.
166166

167-
*These keywords improve discoverability on GitHub and search engines:*
167+
These keywords improve discoverability on GitHub and search engines:
168168

169-
- paxect, freq42, deterministic, reproducible, data-container, wire-format
170-
- crc32, checksum, encryption, aes-256, aes-gcm, aes-ctr
171-
- selftune, autotune, zero-ai, zstandard, compression, streaming
172-
- cross-os, cross-language, polyglot, language-bindings, os-bridge
173-
- file-watcher, inbox-outbox, link-bridge
174-
- audit-compliance, privacy-by-default, edge-computing, iot, system-integration
175-
- Bit-identical runs across OS/languages (audit, compliance, regression).
169+
- **Core/Format:** paxect, freq42, deterministic, reproducible, data-container, wire-format
170+
- **Integrity & Security:** crc32, checksum, encryption, aes-256, aes-gcm, aes-ctr
171+
- **Performance/Runtime:** selftune, zero-ai, autotune, zstandard, compression, streaming
172+
- **Interoperability:** cross-os, cross-language, polyglot, language-bindings, os-bridge
173+
- **Exchange/Pipelines:** file-watcher, inbox-outbox, link-bridge
174+
- **Compliance/Deployment:** audit-compliance, privacy-by-default, edge-computing, iot, system-integration
176175

177-
Soundwave multi-channel: parallel lanes with per-channel ordering (no reordering).
176+
## Why PAXECT (recap)
178177

179-
Operationally simple: Core runs locally; Link uses SMB/NFS/cloud (inbox/outbox).
178+
- Bit-identical runs across OS/languages (audit, compliance, regression)
179+
- Soundwave multi-channel: parallel lanes with per-channel ordering (no reordering)
180+
- Operationally simple: Core runs locally; Link uses SMB/NFS/cloud (inbox/outbox)
181+
- Risk-free extensibility: plugins (AES, SelfTune, Polyglot, Link) without Core changes
182+
- Privacy by default: local execution, no telemetry, Zero-AI
180183

181-
Risk-free extensibility: Plugins (AES, SelfTune, Polyglot, Link) without Core changes.
184+
## Use Cases (examples)
182185

183-
Privacy by default: local execution, no telemetry, Zero-AI.
184-
Use Cases (examples)
186+
- Quantum/Research: package circuits/results/logs reproducibly; share via Link + AES
187+
- AI/ML: tensors/datasets/models as `.freq`; deterministic; optional encryption
188+
- Edge/Robotics/Automotive: stable multi-stream logging + firmware artifacts, cross-OS
189+
- HPC/Big Data: large files + live streams in parallel; integrity guaranteed
190+
- Media/Telemetry: many concurrent channels without head-of-line blocking
185191

186-
Quantum/Research: package circuits/results/logs reproducibly; share securely via Link + AES.
192+
## Plugins (overview)
187193

188-
AI/ML: tensors/datasets/models as .freq; deterministic; optional encryption.
194+
- **AES Secure:** AES-256 GCM/CTR, scrypt KDF, AAD; fail-stop on mismatch
195+
- **Polyglot:** Python/Node.js/Go; same deterministic pipeline across runtimes
196+
- **SelfTune 5-in-1:** guardrails, overhead control, rate-limiting/backpressure, smoothing, light observability
197+
- **Link (Inbox/Outbox):** shared-folder bridge; auto-encode non-`.freq``.freq`, auto-decode `.freq` → files; zero server
189198

190-
Edge/Robotics/Automotive: stable multi-stream logging and firmware artifacts, cross-OS.
199+
## Quick Start
191200

192-
HPC/Big Data: large files + live streams in parallel; integrity guaranteed.
201+
- Encode → Decode → Verify in two commands (Bash/PowerShell)
202+
- Output is bit-identical to input (`cmp` or `fc /b`)
203+
- Optional: run Link watcher and drop files into `inbox/` for auto package/extract
193204

194-
Media/Telemetry: many concurrent channels without head-of-line blocking.
195-
Plugins (overview)
205+
## Data Policy
196206

197-
AES Secure: AES-256 GCM/CTR, scrypt KDF, AAD; fail-stop on mismatch.
207+
- Default limit: **512 MB per operation** (predictable performance; DoS-resistant)
208+
- Configurable: `PAXECT_MAX_INPUT_MB` (e.g., 8192 for 8 GB)
209+
- On exceed → **hard-fail**, no partial output; Link inherits same policy
198210

199-
Polyglot: Python/Node.js/Go; same deterministic pipeline across runtimes.
211+
## Security & Privacy
200212

201-
SelfTune 5-in-1: guardrails, overhead control, rate-limiting/backpressure, smoothing, light observability.
213+
- Integrity: CRC32 per frame; strict parser; **fail-stop** on mismatch
214+
- Confidentiality/Authenticity: **AES-256 GCM** (recommended) or **CTR + AAD/HMAC**
215+
- Privacy: local-only; **no telemetry**; logging is opt-in and minimal
202216

203-
Link (Inbox/Outbox): shared-folder bridge; auto-encode non-.freq → .freq, auto-decode .freq → files; zero server.
204-
Quick Start
217+
## Support & Compatibility
205218

206-
Encode → Decode → Verify in two commands (Bash/PowerShell).
219+
- **OS:** Windows 10/11, Linux, macOS
220+
- **Shells:** CMD/PowerShell/Bash; CI-friendly
221+
- **Languages:** Python • Node.js • Go (more via Polyglot/stdin-stdout)
222+
- **CPU:** x86_64 (tested), ARMv7 (smoke), ARM64 (planned), RISC-V (optional)
207223

208-
Output is bit-identical to input (use cmp/fc /b to verify).
224+
## Roadmap (transparent)
209225

210-
Data Policy
226+
- **Principles:** SemVer 1.x; determinism first; no silent changes
227+
- **Aims for 1.0:** ARM64 builds (where feasible), AES plugin GA, Polyglot stable, SelfTune public, Link stable
228+
- **Post-1.0 (intent):** signed binaries, SBOM/attestations, templates (Kafka/S3/SIEM), LTS; PQC plugins exploration
229+
- *Note:* plan/intent, not a promise; priorities may shift with feedback/tests
211230

212-
Default limit: 512 MB per operation (predictable performance; DoS-resistant).
231+
## License, Community & Contact
213232

214-
Configurable: PAXECT_MAX_INPUT_MB (e.g., 8192 for 8 GB).
233+
- **License:** Apache-2.0 (`LICENSE`, `NOTICE`, `DISCLAIMER.md`)
234+
- **Trademarks:** “PAXECT” + logo (`TRADEMARKS.md`)
235+
- **Contributing:** `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`
236+
- **Security:** responsible disclosure (`SECURITY.md`)
237+
- **Community:** Discussions & Issues; transparent changelogs/roadmap
215238

216-
Behavior: on exceed → hard-fail, no partial output; Link inherits the same policy.
217-
218-
Security & Privacy
219-
220-
Integrity: CRC32 per frame; strict parser; fail-stop on mismatch.
221-
222-
Confidentiality/Authenticity: via AES-256 GCM (recommended) or CTR + AAD/HMAC.
223-
224-
Privacy: local-only; no telemetry; logging is opt-in and minimal.
225-
226-
Support & Compatibility
227-
228-
OS: Windows 10/11, Linux, macOS.
229-
230-
Shells: CMD/PowerShell/Bash; CI friendly.
231-
232-
Languages: Python • Node.js • Go (more via Polyglot/stdin-stdout).
233-
234-
CPU: x86_64 (tested), ARMv7 (smoke), ARM64 (planned), RISC-V (optional).
235-
236-
Roadmap (transparent)
237-
238-
Principles: SemVer 1.x; determinism first; no silent changes.
239-
240-
Aims for 1.0: ARM64 builds (where feasible), AES plugin GA, Polyglot stable, SelfTune public, Link stable.
241-
242-
Post-1.0 (intent): signed binaries, SBOM/attestations, templates (Kafka/S3/SIEM), LTS; PQC plugins exploration.
243-
244-
Note: plan/intent, not a promise; priorities may shift with feedback/tests.
245-
246-
License, Community & Contact
247-
248-
License: Apache-2.0 (LICENSE, NOTICE, DISCLAIMER.md).
249-
250-
Trademarks: “PAXECT” + logo (TRADEMARKS.md).
251-
252-
Contributing: see CONTRIBUTING.md, CODE_OF_CONDUCT.md.
253-
254-
Security: responsible disclosure (SECURITY.md).
255-
256-
Community: Discussions & Issues; transparent changelogs/roadmap.
257-
258-
259-
Determinism: reproducible pipelines for audit/compliance.
260-
Optional: run Link watcher and drop files into inbox/ for auto package/extract.
261239
---
262240

263241

0 commit comments

Comments
 (0)