Skip to content

Add Apache-2.0 license and improve README documentation - #21

Merged
New1Direction merged 1 commit into
mainfrom
claude/korg-readme-launch-2fztha
Oct 5, 2026
Merged

New1Direction merged 1 commit into
mainfrom
claude/korg-readme-launch-2fztha

Conversation

@New1Direction

Copy link
Copy Markdown
Owner

Summary

This PR adds dual licensing support and significantly enhances the project documentation with clearer positioning, quickstart instructions, and validation details.

Key Changes

  • Licensing: Added LICENSE-APACHE file to provide Apache-2.0 as an alternative to the existing MIT license, enabling dual licensing (MIT OR Apache-2.0)

  • README Improvements:

    • Refined tagline to emphasize tamper-evidence and SHA-256 chaining over blockchain terminology
    • Added a 30-second quickstart section with concrete CLI examples showing how to verify a ledger and detect tampering
    • Included a visual demo (tamper.gif) showing the verifier catching a rewritten event
    • Added "Validated across three vendors" section documenting support for Claude Code, OpenAI Codex CLI, and Grok Heavy with adapter locations and test counts
    • Clarified that byte-identical implementations exist across Rust, Python, and JS
    • Removed outdated test count badge
    • Updated license reference in footer to point to correct files
  • Demo Assets:

    • Added tamper.tape — a VHS script that generates an animated demo showing the verifier detecting tampering in a real 6-event Claude Code session
    • Generated tamper.gif from the tape script demonstrating the tamper detection workflow

Notable Details

The quickstart demonstrates the core value proposition: a verifier that requires zero trust in the producer and can detect any single-byte modification to the ledger, with the exact event identified. The three-vendor validation table establishes that the format is production-tested across heterogeneous agent architectures while maintaining a single canonical verifier.

https://claude.ai/code/session_01CT1ehtuNDw4s9khDS3TBtq

…, tamper GIF

- One-line pitch: tamper-evident, SHA-256-chained ledger for AI agents
- 30-second quickstart: build korg-verify, verify a real session ledger,
  rewrite one event, watch the verifier name it (run verbatim from a fresh
  clone; cold build ~10s)
- tamper.gif + tamper.tape: real korg-verify run catching a one-line edit
- "Validated across three vendors (N=3)" table: Claude Code, Codex CLI,
  Grok Heavy adapters with their passing test counts
- Add LICENSE-APACHE and fix the README license links (LICENSE-MIT and
  LICENSE-APACHE were dead links; Cargo.toml already declares MIT OR Apache-2.0)
- Drop the stale "175 tests" badge (Status section reports 300+)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CT1ehtuNDw4s9khDS3TBtq
@New1Direction
New1Direction merged commit 0c0fbc5 into main Oct 5, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants