Skip to content

Commit 73e3a9c

Browse files
PAXECT-InterfacePAXECT-Interface
authored
Update README.md
1 parent ae2ec56 commit 73e3a9c

File tree

1 file changed

+55
-217
lines changed

1 file changed

+55
-217
lines changed

‎README.md‎

Lines changed: 55 additions & 217 deletions
Original file line numberDiff line numberDiff line change
@@ -1,246 +1,84 @@
1-
# PAXECT — Reliable Data Exchange Across Operating Systems and Programming Languages
2-
3-
PAXECT is an open-source platform for deterministic, secure transport and archiving of technical data (files, streams, logs, telemetry, updates) in complex, multi-platform environments. It provides a stable container format (`.freq`), a plug-and-play extension model (encryption, language bindings, performance tuning), and a privacy-first architecture with no telemetry or external data flows.
4-
5-
PAXECT enables reproducible exchange across operating systems (Windows, Linux, macOS, BSD, ARM/embedded, mobile) and integrates with programming languages including Python, JavaScript/Node.js, Rust, Go, Java, C#, PHP, and Ruby.
6-
7-
---
8-
9-
## Important Notice: Free Launch Period
10-
11-
All PAXECT features — including Enterprise/Pro features — are **free for the first 6 months after launch**.
12-
13-
- **Launch date:** 2025-10-01
14-
- **Free period ends:** 2026-04-01
15-
16-
At least **30 days before** the end date we will publish whether the free period is extended or which features become paid (Enterprise/Pro).
17-
**The open-source Core will remain open-source and maintained** under Apache-2.0.
18-
1+
# PAXECT — Betrouwbare data-uitwisseling over besturingssystemen en programmeertalen
192
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
203
[![Build](https://github.com/PAXECT-Interface/PAXECT---Core/actions/workflows/ci.yml/badge.svg)](../../actions)
214
[![CodeQL](https://github.com/PAXECT-Interface/PAXECT---Core/actions/workflows/codeql.yml/badge.svg)](../../actions)
225
[![Discussions](https://img.shields.io/github/discussions/PAXECT-Interface/PAXECT---Core)](../../discussions)
236

7+
PAXECT is een open-source platform voor **deterministisch** en **veilig** transport/archivering van technische data
8+
(bestanden, streams, logs, telemetrie, updates) in multi-platform omgevingen. Het levert een stabiel containerformaat
9+
**`.freq`**, een **plug-and-play** extensiemodel (encryptie, taal-bindings, performance-tuning) en een **privacy-first**
10+
architectuur (geen telemetry, geen externe datastromen). **Zero AI.**
2411

12+
> **Lanceringsperiode (gratis)**: alle features (incl. Enterprise/Pro) zijn gratis t/m **2026-04-01**.
13+
> De Core blijft daarna open-source (Apache-2.0) en onderhouden.
2514
26-
## Table of Contents
27-
- [Core Values](#core-values)
28-
- [Why PAXECT](#why-paxect)
29-
- [Use Cases](#use-cases)
30-
- [Compatibility](#compatibility)
31-
- [Installation & Usage (Quickstart)](#installation--usage-quickstart)
32-
- [Plugins & Extension Points](#plugins--extension-points)
33-
- [Roadmap](#roadmap)
34-
- [Community & Governance](#community--governance)
35-
- [Licensing & Trademark](#licensing--trademark)
36-
- [Privacy & Security](#privacy--security)
37-
- [Disclaimer & Liability](#disclaimer--liability)
38-
- [Contact](#contact)
39-
40-
41-
42-
43-
44-
## Core Values
45-
- **Deterministic** — Same input + configuration ⇒ bit-identical output (audit/compliance/regression).
46-
- **Multi-OS & multi-language** — Native support across OS families with broad language bindings.
47-
- **Extensible** — Plug-and-play modules for encryption, observability, performance, and extra bindings.
48-
- **Privacy & security** — No tracking or cloud dependency; optional AES-based encryption; explicit integrity checks.
49-
- **Transparency** — Apache-2.0 licensing, public roadmap, compatibility matrix, and benchmarks. **Zero AI.**
50-
51-
-
52-
-
53-
- ## Why PAXECT
54-
55-
- **Reliable in heterogeneous environments** — consistent containers across Linux/Windows/macOS/BSD/embedded.
56-
- **Audit-ready & reproducible** — deterministic processing (bit-identical with same input/config) for compliance and QA.
57-
- **Fast integration** — stable `.freq` wire format plus plug-and-play plugins (encryption, language bindings, tuning).
58-
- **Operational confidence** — strict integrity checks (per-frame CRC), fail-hard on truncation/corruption, clear exit behavior.
59-
- **Privacy-first** — no telemetry or external uploads; optional AES-based confidentiality via plugin (opt-in).
60-
61-
62-
63-
64-
## Compatibility
65-
66-
### Operating systems (status)
67-
| OS family | Status | Notes |
68-
|-------------------------|------------|----------------------------------------------------------|
69-
| Linux (x86_64) | Tested | Ubuntu 20.04/22.04; kernel 6.x; soak/benchmarks complete |
70-
| Windows 10/11 (x86_64) | Tested | PowerShell smoke OK; update payloads bit-identical |
71-
| macOS (x86_64/arm64) | Partial | Decode OK; full soak planned |
72-
| BSD (Free/Open) | Partial | Smoke OK |
73-
| Embedded Linux / RTOS | Concept | Same API/FFI; hardware runs welcome |
74-
| Android (NDK/JNI) | OS-ready | Not yet tested |
75-
| iOS (C/Swift bridge) | OS-ready | Not yet tested |
76-
77-
> Full details and logs: see `docs/LabReport.md`.
78-
79-
### CPU architectures
80-
- **x86_64**: primary test target
81-
- **ARMv7**: smoke via QEMU-chroot OK
82-
- **ARM64**: planned (native builds/tests)
83-
- **RISC-V**: optional; same flow as ARM
84-
85-
### Languages (via Polyglot)
86-
Bindings available for **Python, JavaScript/Node.js, Go, C/C++, Java, C#, PHP, Ruby, Rust**.
87-
> Availability may vary by edition; see **[Licensing & Trademark](#licensing--trademark)**.
88-
89-
### Container format
90-
- Stable **`.freq`** (version **42**)
91-
- **Frame-based** I/O with per-frame **CRC32**
92-
- Fixed **footer/metadata**; strict parsing
93-
- **Deterministic decode**, platform/endianness-agnostic
94-
95-
96-
97-
98-
99-
## Installation & Usage (Quickstart)
100-
101-
### Prerequisites
102-
- **OS:** Linux, Windows, macOS (see matrix above)
103-
- **CPU:** x86_64 tested; ARMv7 smoke OK; ARM64 planned
104-
- **I/O & storage:** enough disk for inputs + temporary frames
105-
106-
### Install (high level)
107-
- **Core library:** build/install the platform library (`.so`/`.dll`/`.dylib`)
108-
- **Bindings (Polyglot):** choose your language binding (Python / Node.js / Go, etc.)
109-
- **Smoke run:** encode → decode; verify checksums, per-frame CRC, footer (version 42)
110-
111-
### Use (conceptual)
112-
- **Encode (input → `.freq`):** frame data, optional delta/mapping, compress (zstd/LZ4/zlib), CRC per frame, write footer (v42)
113-
- **Decode (`.freq` → output):** parse footer, validate CRC, optional decrypt (AES plugin), decompress, reconstruct bytes
114-
- **Streaming:** stdin/stdout supported; bounded peak memory via frames
115-
- **Multi-channel:** process multiple channels in parallel with channel isolation
116-
117-
### Failure & exit behavior
118-
- CRC mismatch, truncation, invalid metadata ⇒ **hard fail** (no partial output)
119-
- If encryption is enabled: wrong key/tag/AAD ⇒ **strict fail**
120-
121-
### Verification & audit
122-
- Compare input/output checksums; inspect footer/flags
123-
- Keep logs/CSV artifacts for benchmarks and regressions (`docs/LabReport.md`)
124-
125-
126-
127-
128-
## Plugins & Extension Points
129-
130-
### Official plugins
131-
| Plugin | Scope | Highlights | Repository |
132-
|--------------------------|--------------------------------|---------------------------------------------------|------------|
133-
| PAXECT AES Secure Plugin | Confidentiality & authenticity | AES-256 GCM/CTR, scrypt KDF, AAD, strict fail | https://github.com/PAXECT-Interface/paxect-aes-plugin |
134-
| PAXECT Polyglot Plugin | Language bindings | Python, Node.js, Go, C/C++, Java, C#, PHP, Ruby… | https://github.com/PAXECT-Interface/paxect-polyglot-plugin |
135-
| PAXECT SelfTune 5-in-1 | Performance & observability | Guard, overhead control, logging, smoothing, auto-learning | https://github.com/PAXECT-Interface/paxect-selftune-5in1 |
136-
137-
### Plug-and-play model
138-
- **Optional & decoupled:** Core werkt zonder plugins; plugins voegen functies toe zonder Core te wijzigen.
139-
- **Activation per run:** via config/flag of via de binding-API.
140-
- **Determinism unchanged:** containers blijven v42-conform; reproduceerbaarheid blijft intact.
141-
- **Overhead:** uit = geen overhead; aan = alleen geselecteerde plugin(s).
142-
143-
### Extension points
144-
- **Pre-processing hooks:** mapping/delta vóór compressie (deterministisch).
145-
- **Container transforms:** encryptie/integriteit op containerniveau (AES-plugin).
146-
- **I/O adapters:** extra sources/sinks naast file en stdin/stdout.
147-
148-
149-
150-
151-
## Roadmap
152-
153-
### v0.9.0 (pre-release)
154-
- Deterministic encode/decode; frame I/O + per-frame CRC32; footer v42.
155-
- Compressors: zstd / LZ4 / zlib; optional delta/mapping.
156-
- Docs: README, `docs/LabReport.md`, OS matrix.
157-
- CI (basis): determinism, truncation/corruption, streaming.
158-
159-
### v1.0.0 (stable)
160-
- OS-matrix breder: Windows CMD smoke, macOS soak; eerste ARM64 build/run.
161-
- Plugins: AES Secure release; Polyglot (Python/Node.js/Go stable); SelfTune 5-in-1 public (lab-getest).
162-
- Artefacts: fixed workloads + CSV/JSONL in `benchmarks/`; golden vectors.
163-
164-
### Post-1.0
165-
- Prebuilt binaries per OS/CPU (gesigneerd waar nodig), SBOM/attestations.
166-
- Verdere bindings (Java, C#) en integraties (Kafka, S3/Azure, SIEM).
167-
- Android/iOS native runs; SelfTune-profielen en overhead-budgets.
168-
- Governance: LTS-schema, compat-matrix per release.
169-
170-
171-
172-
173-
## Community & Governance
174-
175-
- **Issues / Discussions** — Support, Q&A, designvoorstellen, OS-readiness rapporten.
176-
- **Contributing** — Zie `CONTRIBUTING.md` (workflow, tests, code style, commit conventies).
177-
- **Code of Conduct** — Zie `CODE_OF_CONDUCT.md`.
178-
- **Security** — Responsible disclosure in `SECURITY.md` (contact + eventueel PGP).
179-
180-
### Maintainers & rollen (aanbevolen)
181-
- **Core**: 2–3 maintainers (triage, reviews, releases, docs).
182-
- **Plugins**: 1–2 per plugin (AES, Polyglot, SelfTune).
183-
- **Moderation/CI (optioneel)**: 1–2 voor Discussions/CI.
184-
185-
### Good first issues (suggesties)
186-
- Windows **CMD** smoke (`smoke.cmd`); macOS **soak**; **ARM64** native run.
187-
- RISC-V optioneel; Android NDK/JNI eerste load.
188-
189-
190-
191-
192-
## Licensing & Trademark
15+
---
19316

194-
### Free Base Tier (OSS) — first 6 months from 2025-10-01
195-
- **All features are free** during the launch period (until **2026-04-01**).
196-
- **OS (official):** Linux x86_64, Windows 10/11 x86_64, macOS x86_64/arm64
197-
- **Languages (Polyglot):** Python, JavaScript/Node.js, Go
198-
- **Security:** AES-256 GCM/CTR (basic), scrypt KDF, AAD
199-
- Community support; monthly OSS releases
17+
## Kerneigenschappen
18+
- **Deterministisch** — zelfde input + configuratie ⇒ bit-identieke output (audit/compliance/regressie).
19+
- **Multi-OS & polyglot** — Windows, Linux, macOS; bindings voor Python, Node.js, Go (meer via plugins).
20+
- **Integriteit eerst** — frame-I/O met **CRC32 per frame** en strikte parsing (fail-hard bij fouten).
21+
- **Uitbreidbaar** — encryptie, bindings en tuning als optionele plugins (zonder wijzigingen in Core).
22+
- **Privacy by default** — lokale uitvoering; geen tracking/telemetry.
20023

201-
### After the free period
202-
- We announce ≥30 days in advance which features remain free vs. move to Enterprise/Pro.
203-
- **PAXECT Core remains open-source and maintained** under Apache-2.0.
24+
---
20425

205-
### Enterprise/Pro (may apply after the free period)
206-
- **Performance & Ops:** SelfTune 5-in-1 (guard, overhead, logging, smoothing, auto-learning)
207-
- **Security & Compliance:** HSM/KMS integratie, FIPS modes, compliance/audit logging
208-
- **Languages:** Java (JNI), C#/.NET (P/Invoke); possible “enhanced” features for Python/Node/Go
209-
- **Delivery:** signed builds, SBOM/attestations, LTS maintenance, SLA support
210-
- **Integrations:** Kafka, S3/Azure Blob, SIEM export (Splunk/ELK), policy hooks
26+
## Supportmatrix (basismodel)
27+
| Domein | Officieel (OSS) | Notities / Volledige matrix |
28+
|--------------|--------------------------------------------------------|-----------------------------|
29+
| **OS** | Linux x86_64 · Windows 10/11 x86_64 · macOS x86_64/arm64 | Zie `docs/LabReport.md` |
30+
| **Talen** | Python · JavaScript/Node.js · Go | Extra via Polyglot-plugin |
31+
| **CPU** | x86_64 (getest) · ARMv7 (smoke) · ARM64 (gepland) | RISC-V optioneel |
21132

212-
### Legal
213-
- **License:** Apache License 2.0 (`LICENSE`, `NOTICE`)
214-
- **Trademarks:** use of the “PAXECT” name and logo is governed by `TRADEMARKS.md` (no confusing branding).
215-
- **Commercial modules:** optional Enterprise/Pro features may be offered under separate terms.
33+
**Container:** `.freq` (v42) · CRC32 per frame · vaste footer/metadata · deterministische decode.
21634

35+
---
21736

37+
## Snel starten
38+
1. **Installeer Core** voor jouw OS/CPU (`.so/.dll/.dylib`).
39+
2. **Kies een binding** (Python / Node.js / Go via Polyglot).
40+
3. **Smoke-run:** encode → decode; verifieer CRC/footer (v42).
41+
→ Zie **Installatie & Gebruik** hieronder en `docs/LabReport.md`.
21842

43+
---
21944

220-
## Privacy & Security
45+
## Plugins (officieel)
46+
| Plugin | Scope | Highlights | Repo |
47+
|---------------------|--------------------------------|----------------------------------------------------------|------|
48+
| **AES Secure** | Vertrouwelijkheid & integriteit| AES-256 GCM/CTR, scrypt KDF, AAD, strikt falen | https://github.com/PAXECT-Interface/paxect-aes-plugin |
49+
| **Polyglot** | Taal-bindings | Python, Node.js, Go; extra talen via enterprise | https://github.com/PAXECT-Interface/paxect-polyglot-plugin |
50+
| **SelfTune 5-in-1** | Performance & observability | Guard, overhead-controle, logging, smoothing, auto-learning | https://github.com/PAXECT-Interface/paxect-selftune-5in1 |
22151

222-
- **Privacy-first:** no telemetry, no external uploads; local by default.
223-
- **Security scope (Core):** integrity + determinism (per-frame CRC32, strict parsing, fail-hard).
224-
- **Confidentiality (opt-in):** via AES Secure Plugin (AES-256 GCM/CTR, scrypt KDF, AAD).
225-
- **Docs:** see `docs/PRIVACY.md` and `SECURITY.md`.
52+
**Plug-and-play:** Core draait zonder plugins; per run inschakelen via config/flag of binding-API. Determinisme blijft gelijk.
22653

227-
> Verify runs via checksums and footer/flags; store logs/CSV artefacts for audits.
54+
---
22855

56+
## Installatie & Gebruik (Quickstart)
57+
- **Vereisten:** Linux/Windows/macOS; x86_64; voldoende schijfruimte voor input + tijdelijke frames.
58+
- **Encode (→ `.freq`):** framen → (optioneel) delta/mapping → compressie (zstd/LZ4/zlib) → CRC per frame → footer (v42).
59+
- **Decode (van `.freq`):** footer parsen → CRC valideren → (optioneel) decrypt → decompresseren → bytes reconstrueren.
60+
- **Streaming:** stdin/stdout met begrensd geheugen; onderbrekingen worden gedetecteerd.
61+
- **Foutgedrag:** CRC-mismatch / truncatie / ongeldige metadata ⇒ hard fail (geen gedeeltelijke output).
22962

63+
---
23064

231-
## Disclaimer & Liability
65+
## Roadmap (hoogover)
66+
- **v0.9.0:** deterministische Core; zstd/LZ4/zlib; LabReport; basis-CI (determinisme/streaming/corruptie).
67+
- **v1.0.0:** bredere OS-matrix (Windows CMD, macOS soak), eerste ARM64 build; AES-release; Polyglot stable; SelfTune public.
68+
- **Na 1.0:** prebuilt binaries, SBOM/attestations, extra bindings/integraties (Kafka/S3/SIEM), LTS.
23269

233-
This software is provided “as is”, without warranty of any kind, express or implied.
234-
The owner, maintainers, and contributors shall not be liable for any direct, indirect, incidental, special, or consequential damages arising from the use of this software.
235-
See `LICENSE` (Apache-2.0) for details.
70+
---
23671

72+
## Governance, Security & Privacy
73+
- **Licentie:** Apache-2.0 (`LICENSE`, `NOTICE`) · **Merken:** zie `TRADEMARKS.md`.
74+
- **Bijdragen & Gedragscode:** `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`. **Security:** `SECURITY.md`.
75+
- **Privacy:** geen telemetry of externe uploads; lokaal by default. Zie `docs/PRIVACY.md`.
23776

77+
---
23878

23979
## Contact
80+
**[email protected]** · Issues: https://github.com/PAXECT-Interface/PAXECT---Core/issues · Discussions: https://github.com/PAXECT-Interface/PAXECT---Core/discussions
24081

241-
Questions or collaboration: **[email protected]**
242-
Issues: https://github.com/PAXECT-Interface/PAXECT---Core/issues
243-
Discussions: https://github.com/PAXECT-Interface/PAXECT---Core/discussions
24482

24583

24684

0 commit comments

Comments
 (0)