Skip to content

docs: rewrite README for open-source marketing#14

Merged
dmitriimaksimovdevelop merged 1 commit into
masterfrom
docs/readme-marketing
Apr 2, 2026
Merged

docs: rewrite README for open-source marketing#14
dmitriimaksimovdevelop merged 1 commit into
masterfrom
docs/readme-marketing

Conversation

@dmitriimaksimovdevelop

Copy link
Copy Markdown
Owner

What changed

Complete README rewrite optimized for open-source adoption and article publication.

Added

  • Hero section — "Your server is slow. Now what?" — immediate value proposition
  • Key Features table — 12 features at a glance
  • "Who Is This For?" — SRE, ML Engineers, DBA, Platform Teams, AI Agents
  • Comparison vs alternatives — prometheus/netdata/datadog positioning
  • Roadmap — community-facing direction (AMD ROCm, OpenTelemetry, Web UI)
  • Contributing guide — specific help-wanted areas (BCC parsers, AMD GPU, docs)
  • Documentation section — highlights 22-chapter book-level guide
  • Attribution — Brendan Gregg, USE Method, cilium/ebpf

Fixed

  • All numbers: 458 tests, 37 rules, 67 tools, 8 collectors
  • jq paths corrected for schema v1.1.0 sub-structs
  • Added test count and schema badges

Removed

  • Redundant "Manual Usage" jq section (consolidated into shorter block)
  • Duplicate information between sections

🤖 Generated with Claude Code

Restructured for maximum impact when publishing articles:

- Hero section with value proposition ("Your server is slow. Now what?")
- Key Features table (12 features at a glance)
- "Who Is This For?" section (SRE, ML, DBA, platform, AI agents)
- Comparison table vs prometheus/netdata/datadog
- Roadmap section for community direction
- Contributing section with specific help-wanted areas
- Documentation section highlighting 22-chapter guide (EN+RU)
- All numbers accurate: 458 tests, 37 rules, 67 tools, 8 collectors
- Fixed jq paths for schema v1.1.0 sub-structs
- Added test/schema badges
- Attribution to Brendan Gregg ecosystem

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@dmitriimaksimovdevelop dmitriimaksimovdevelop merged commit 0b8c862 into master Apr 2, 2026
1 check 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.

1 participant