docs: professional README rewrite (v0.1-aware)#6
Merged
SwathiMystery merged 1 commit intomainfrom Apr 21, 2026
Merged
Conversation
- Tighten hero: add tagline, zero-telemetry badge, refined nav - Replace 'what you'll see' with real CLI + web UI sections reflecting v0.1 - New 'why khata exists' positioning paragraph above the comparison table - Reorder features by what's shipped vs roadmap milestones - Add an ASCII architecture diagram (adapter → engine → SQLite → CLI+UI) - Expand FAQ (tax, asset classes, VPS, token safety) - Acknowledge HTMX alongside brokers and Indian incumbents - Footer with repo URL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
README refresh that reflects the actual state of the project after v0.1 — calendar heatmap, day/trade detail pages, recomputed fees, paginated statement API. Tighter positioning up top, an architecture diagram, and an expanded FAQ.
Why
The previous README was scaffold-era copy. It promised 'pre-alpha' and lacked the local web UI section. New contributors and skeptical evaluators land on the README first — it needs to communicate the actual shipped state and the reason the project exists in one screenful.
Key changes
telemetry-zerobadge alongside the existing CI/licence/Python/status badgeskhata websnippet + stats tableChecklist