Skip to content

Epic README rewrite: dual-track install, full module docs, professional branding #1

Description

@narko4u

Summary

Complete README overhaul for PROTOCOL — the open-source Agent Operating System. Rewrote from basic documentation to a professional, dual-audience layout showcasing Empire Labs' ability to serve both novices and experienced developers.

Changes

  • Dual-track install: Novice path (5-minute step-by-step with screenshots) and Developer path (CLI, Python SDK, Docker, env vars, framework integrations)
  • Visual rebranding: Shields/buttons, professional header, colour-coded module table
  • Full architecture diagram: ASCII art showing agent → PROTOCOL core → infrastructure stack
  • Code examples for 3 frameworks: LangGraph, CrewAI, AutoGen integration snippets
  • Security section: Token auth, SHA-256 chains, PII redaction, circuit breakers
  • Testing section: pytest instructions with module-by-module test coverage
  • Gumroad / Cloud CTA: Links to free listing and PROTOCOL Cloud inquiry
  • Empire Labs branding: ACN, ABN, website, contact consistent across footer

Files changed

  • README.md — 357 insertions, 46 deletions (complete rewrite)

Verification

Commit: c936e08

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions