From b250afb3e4ca2b495728a97dd2215256c2dd4341 Mon Sep 17 00:00:00 2001 From: Stefan Schmidt-Egermann Date: Sat, 25 Apr 2026 12:04:03 +0200 Subject: [PATCH] docs: cross-links updated to 3-level structure --- CONTRIBUTING.md | 39 +++++++++++++++++++++++ README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++-- SECURITY.md | 33 ++++++++++++++++++++ 3 files changed, 152 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b85282c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing + +Vielen Dank für dein Interesse an der hightrusted CAPTURE API. + +## Wer kann beitragen + +Diese Repositorys werden primär von hightrusted GmbH gepflegt. Wir freuen uns +über Bug-Reports, Verbesserungsvorschläge und Pull-Requests aus der Community. + +## Issues + +- **Bug-Report:** beschreibe das erwartete vs. tatsächliche Verhalten und liefere + einen reproduzierbaren Code-Schnipsel mit. Bitte keine API-Keys mit posten. +- **Feature-Request:** beschreibe den Use-Case — wir entscheiden, ob das Feature + in das SDK gehört oder besser direkt gegen die API umgesetzt wird. + +## Pull Requests + +1. Fork und Branch (`feat/...`, `fix/...`, `docs/...`). +2. Tests anpassen oder ergänzen. +3. Lokale Build-Pipeline grün bekommen (siehe README). +4. **Commits signieren** — sowohl GPG als auch X.509 werden akzeptiert. Unsignierte + Commits werden nicht gemerged. +5. PR öffnen mit klarer Beschreibung: Was ändert sich, warum, Breaking Change ja/nein. + +## Code-Stil + +Jede Sprache hat ihre eigene Konvention — siehe README des jeweiligen Repos. +Tendenziell: Pflegt euch an den Standards, die wir bereits im Code verwenden. + +## Lizenz + +Beiträge gehen unter der MIT-Lizenz ein (siehe `LICENSE`). Mit dem Öffnen eines +PRs bestätigst du, dass du das Recht hast, deinen Beitrag unter diese Lizenz zu +stellen. + +## Kontakt + +`developers@hightrusted.net` diff --git a/README.md b/README.md index 38e44cf..2534ce3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,81 @@ -# capture-examples +# hightrusted CAPTURE — Examples -Beispiel-Anwendungen mit der hightrusted CAPTURE API \ No newline at end of file +> **Status:** v0.1 Preview — Beispiele wachsen mit den Use-Cases unserer Kunden + +Längere, in sich geschlossene Beispiel-Anwendungen für die +[hightrusted CAPTURE API](https://capture.hightrusted.net). + +Während die SDK-Repos (`python`, `node`, `php`) die Bibliothek selbst enthalten, +zeigt dieses Repo **vollständige Anwendungen** — Code, den du forken, anpassen +und produktiv einsetzen kannst. + +**Made in Germany.** Server in Deutschland. DSGVO-nativ. + +## Beispiele (geplant) + +| Verzeichnis | Sprache | Use-Case | +|-----------------------------|----------|----------| +| `markenrecht-monitoring/` | Python | Tägliche Capture markenrechtlich relevanter Domains, automatische E-Mail bei Änderung | +| `agb-archivierung/` | Node.js | AGB & Datenschutzerklärungen großer Anbieter regelmäßig sichern und versionieren | +| `wordpress-plugin/` | PHP | WordPress-Plugin: Beweissicherung von Kommentaren, Forenbeiträgen, Bewertungen | +| `compliance-batch/` | Python | Batch-Capture: CSV mit URLs einlesen, alle capturen, Audit-Log als ZIP | +| `webhook-receiver/` | Node.js | Express-Webhook-Server, der `capture.ready` Events validiert und PDFs ablegt | +| `nextcloud-integration/` | PHP | Nextcloud-App: Rechtsklick auf Link → Capture erstellen → in Nextcloud speichern | + +> Diese Beispiele werden Schritt für Schritt befüllt. Jedes Verzeichnis enthält +> einen eigenen `README.md` mit Setup-Anleitung, Voraussetzungen und Lizenz. + +## Anwendungsfälle in der Praxis + +**Kanzleien & Sachverständige.** Beweissicherung von Web-Inhalten, die Beklagte +nach Klage-Eingang löschen würden — ein Capture mit qualifiziertem Zeitstempel +ist gerichtsverwertbar. + +**Aufsichtsbehörden & Compliance-Abteilungen.** Regelmäßige Snapshots von +Anbieter-AGB, Preislisten und Datenschutzerklärungen für die Aufbewahrung. + +**KMU mit kritischen Web-Inhalten.** Eigene Webseite, Online-Bewertungen, +Bewerber-Portale archivieren. + +## Voraussetzungen + +Ein hightrusted-Account mit API-Key — kostenlos im Developer-Plan +(100 Calls/Monat zum Ausprobieren): +https://capture.hightrusted.net/dashboard/api-keys + +## Beitragen + +Du hast ein Beispiel gebaut, das andere weiterbringen würde? Pull-Request öffnen! +Siehe [CONTRIBUTING.md](./CONTRIBUTING.md). + +## Verwandte Repositorys + +**Im selben Produkt** ([`hightrusted-capture`](https://git.hightrusted.net/hightrusted-capture)): + +- [`openapi`](https://git.hightrusted.net/hightrusted-capture/openapi) — OpenAPI 3.1 Spec (Single Source of Truth) +- [`postman`](https://git.hightrusted.net/hightrusted-capture/postman) — Postman Collection +- [`python`](https://git.hightrusted.net/hightrusted-capture/python) — Python-SDK +- [`node`](https://git.hightrusted.net/hightrusted-capture/node) — Node.js-SDK +- [`php`](https://git.hightrusted.net/hightrusted-capture/php) — PHP-SDK + +**Plattform-übergreifend** ([`hightrusted`](https://git.hightrusted.net/hightrusted)): + +- [`platform`](https://git.hightrusted.net/hightrusted/platform) — Plattform-Übersicht, Architektur, Produkt-Liste +- [`developer-portal`](https://git.hightrusted.net/hightrusted/developer-portal) — gemeinsame Konventionen, Auth, Errors, Rate-Limits +- [`compliance`](https://git.hightrusted.net/hightrusted/compliance) — DSGVO, AGB-Templates, Whitepaper + +## Support + +- **Doku:** https://capture.hightrusted.net/api/docs +- **Status-Page:** https://status.hightrusted.net +- **Developer Support:** developers@hightrusted.net +- **Sicherheitslücken:** siehe [SECURITY.md](./SECURITY.md) + +## Lizenz + +MIT — siehe [LICENSE](./LICENSE). + +--- + +**hightrusted GmbH** — *The European Trust Infrastructure.* +Made in Germany. DSGVO-nativ. eIDAS-konform. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..9ed887a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,33 @@ +# Security Policy + +## Sicherheitslücken melden + +Wenn du eine Sicherheitslücke in diesem SDK oder in der hightrusted CAPTURE API +findest, **öffne kein öffentliches Issue**. Stattdessen: + +- **E-Mail:** `security@hightrusted.net` +- **PGP-Key:** veröffentlicht auf https://hightrusted.net/.well-known/security.txt + +Bitte gib in der Meldung an: + +- Betroffenes Repository / SDK-Version +- Beschreibung der Schwachstelle und potenzielle Auswirkung +- Schritte zur Reproduktion +- Falls vorhanden: Proof-of-Concept-Code + +Wir bestätigen den Eingang innerhalb von 48 Stunden und arbeiten an einer +zeitnahen Behebung. Verantwortliche Offenlegung wird honoriert — wir nennen +Reporter (auf Wunsch) in den Release-Notes. + +## Unterstützte Versionen + +Während der `v0.x`-Phase werden nur die jeweils aktuellste Minor-Version und +deren letzte zwei Patch-Versionen aktiv mit Sicherheits-Updates versorgt. + +Ab `v1.0` gilt: aktuelle Major + vorherige Major (12 Monate Übergangsfrist). + +## Out of Scope + +Diese Policy gilt für die SDKs in diesem Repository und die zugehörige +hightrusted CAPTURE API. Für Schwachstellen in anderen hightrusted-Produkten +(SIGN, ID, MEET, PAY, …) gilt jeweils die dortige `SECURITY.md`.