Skip to content

Improve README.md documentation and clarity #1

Description

@udaycodespace

Problem statement:

The current README.md is functional but could be improved for better clarity, 
onboarding speed, and OSS contributor-friendliness. Some sections (e.g. Demo Accounts, 
Custom Hooks) have TODOs that need real content, and formatting/structure could be 
tightened for readability.

Proposed solution:

- Fill in remaining TODO placeholders (demo accounts, seed script status)
- Add a badges section for build status once CI is added
- Improve the Getting Started flow with clearer step numbering
- Add screenshots/GIFs of the app in the Overview section
- Proofread and tighten wording throughout

Alternatives considered:

N/A 

Additional context:

Good first issue for new contributors — low risk, high visibility, helps OSS readiness.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions