docs: overhaul README with architecture diagram and project guide - #65
Merged
Merged
Conversation
…ct guide Rewrite the README into a standard, detailed guide: quick start with prerequisites and env config, app structure, tech-stack and feature tables with source links, wallet/security/offline notes, testing and CI/CD sections, and a roadmap. Add an embedded SVG system-architecture diagram showing where the app sits in the StepFi protocol, and add a LICENSE file (MIT) referenced by the badge.
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.
Summary
Rewrites the README from a short stub into a standard, well-detailed guide and adds an embedded system-architecture diagram showing where the mobile app sits in the StepFi protocol (App ↔ API ↔ Wallets ↔ Contracts on Stellar). Content is corrected against the current code — real tab routes, the Freighter + Lobstr wallet setup, and accurate feature/roadmap status. Also adds an MIT
LICENSEreferenced by the README badge.Docs/assets only — no application code changed.
Type of change
Testing
expo export --platform webunaffected — verified by CI)Notes
assets/architecture.svg(hand-authored, GitHub-rendered).