Skip to content

[Docs] Rewrite README to match the actual stack and document env vars #15

@grantfox-oss

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

The README marks Stellar wallet integration, state management, and dark mode as planned, but the code already ships Freighter, Zustand stores, and a theme store with dark mode. New contributors are misled. The .env.example keys are also undocumented.

Acceptance criteria

  • Update Tech Stack, Features, Wallet Integration, and State Management sections to reflect what is implemented
  • Document every variable in .env.example with purpose and example value
  • Fix Available Scripts to match package.json after the scripts issue lands
  • Remove or clearly mark sections that are genuinely future work

Files to touch

  • README.md
  • .env.example

Out of scope

  • Architecture deep-dive doc (separate)

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions