Skip to content

docs: enterprise-level README rewrite with accuracy fixes#28

Merged
kolkov merged 1 commit intomainfrom
fix/readme-audit
Mar 2, 2026
Merged

docs: enterprise-level README rewrite with accuracy fixes#28
kolkov merged 1 commit intomainfrom
fix/readme-audit

Conversation

@kolkov
Copy link
Copy Markdown
Contributor

@kolkov kolkov commented Mar 2, 2026

Summary

Enterprise-level README rewrite with accuracy fixes validated against source code.

Critical fixes:

  • Fix strlen example: avalue elements must be pointers TO argument values (unsafe.Pointer(&strPtr))
  • Fix benchmark minimum: 64 ns → 88 ns (actual BenchmarkGoffiOverhead result)
  • Fix CGO overhead: ~2 ns/op → ~140 ns/op (Go 1.26) — old value was direct Go baseline
  • Fix Windows SEH: Go 1.22+ added partial support (#58542), not "planned for Go 1.26"
  • Fix architecture diagram: 3 layers (removed non-existent JMP Stub layer)

Style improvements:

  • Remove emoji section headers for professional tone
  • Features, Roadmap, Documentation as clean tables
  • Add Acknowledgments section (purego, libffi, Go runtime)
  • Add Ecosystem section with project table

Test plan

  • CI passes (no code changes, docs only)
  • All README links resolve correctly
  • Renders properly on GitHub

- Fix CRITICAL strlen example: avalue must be pointers TO values
- Fix benchmark claim: 64-114ns → 88-114ns (actual minimum)
- Fix CGO overhead: ~2 ns/op → ~140 ns/op (Go 1.26)
- Fix Windows SEH: Go 1.22+ added partial support, not 1.26
- Fix architecture diagram: 3 layers (removed non-existent JMP Stub)
- Remove emoji section headers for professional tone
- Add Features/Roadmap/Documentation as clean tables
- Add Acknowledgments section (purego, libffi, Go runtime)
- Add Ecosystem section with project table
@kolkov kolkov merged commit 1ae2a99 into main Mar 2, 2026
8 checks passed
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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