Skip to content

docs: rewrite README.md with comprehensive project documentation#3

Merged
Shaqal7 merged 2 commits intomainfrom
copilot/update-readme-file
Feb 9, 2026
Merged

docs: rewrite README.md with comprehensive project documentation#3
Shaqal7 merged 2 commits intomainfrom
copilot/update-readme-file

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 9, 2026

README was a bare skeleton that didn't reflect the project's architecture, current state, or technical decisions.

Rewrote to include:

  • Why Taran — positioning vs JMeter/K6/Goose, key differentiators (zero GC, Coordinated Omission handling, single binary)
  • Architecture diagram — ASCII art showing the full component flow: CLI → Config → Execution Engine (VUs) → Protocol Clients → Metrics → Reporters
  • Workspace structure — table mapping all 7 crates to their responsibilities with dependency flow description
  • Scenario configuration reference — all 4 load profiles (constant, ramp, stepped, spike), step definitions, assertions, extractors
  • Current status — honest split between implemented features and planned phases (1–6)
  • Technology stack — linked table of all key dependencies (Tokio, reqwest, rustls, Rhai, hdrhistogram, etc.)
  • Development guide — prerequisites, build/test/lint commands, project conventions (strict Clippy, no unwrap, conventional commits)

Content sourced from docs/PLAN.md, CLAUDE.md, and the actual crate implementations.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Shaqal7 <13103697+Shaqal7@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README.md to accurately reflect project details docs: rewrite README.md with comprehensive project documentation Feb 9, 2026
Copilot AI requested a review from Shaqal7 February 9, 2026 22:54
@Shaqal7 Shaqal7 marked this pull request as ready for review February 9, 2026 22:57
@Shaqal7 Shaqal7 merged commit 5742b5e into main Feb 9, 2026
5 checks passed
@Shaqal7 Shaqal7 deleted the copilot/update-readme-file branch February 9, 2026 22:57
@Shaqal7 Shaqal7 restored the copilot/update-readme-file branch February 9, 2026 23:03
@Shaqal7 Shaqal7 deleted the copilot/update-readme-file branch February 9, 2026 23:11
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