Rewrite README for general users - #11
Merged
Merged
Conversation
Leads with what the tool does and a plain-language walkthrough (get credentials, doctor, inspect, tunnel, replay) instead of an internal milestone status table.
There was a problem hiding this comment.
Pull request overview
Rewrites README.md to be more approachable for general/non-technical users by emphasizing what mpesa-dev does, how it helps with Daraja sandbox development, and providing a step-by-step “Using it” walkthrough while deferring deeper reference material to RUNNING.md.
Changes:
- Replaces the internal status/milestone section with a plain-language feature overview (
doctor,inspect,tunnel,replay). - Adds a guided “Using it” flow (get sandbox credentials → configure →
doctor→inspect→ public URL →replay). - Updates installation guidance copy to steer new users toward the simplest option.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ██║ ╚═╝ ██║ | ||
| ╚═╝ ╚═╝ | ||
|
|
||
| M-Pesa Developer Toolkit v0.1.0 |
| **The missing local development toolkit for M-Pesa Daraja.** | ||
|
|
||
| ## Status | ||
| Every Daraja tutorial tells you to bolt on ngrok for callback testing and Google `ResultCode` values at 2am. `mpesa-dev` fixes both. One static binary — no Node, no `npm install`, no version drift between your machine and the tutorial you copied from. |
| ``` | ||
|
|
||
| See [RUNNING.md](RUNNING.md#packaging--installing) for details on each path, including what's actually been verified vs. what's a documented-but-untested template. | ||
| New to Rust or unsure which to pick? Use the curl script — it just downloads a ready-to-run binary, nothing to compile. See [RUNNING.md](RUNNING.md#packaging--installing) for details on each path. |
DENNIS-CODES
added a commit
that referenced
this pull request
Aug 11, 2026
…8enz0d Rewrite README for general users
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
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.
Summary
doctor→inspect→ get a public URL →replay)Test plan
cargo build --all-targetscargo fmt --all -- --checkGenerated by Claude Code