Skip to content

docs: add Getting Started guide, contribution table, CI badges to README (closes #59) - #71

Open
mayank-dev-15 wants to merge 1 commit into
Anamandla:mainfrom
mayank-dev-15:docs/readme-getting-started
Open

docs: add Getting Started guide, contribution table, CI badges to README (closes #59)#71
mayank-dev-15 wants to merge 1 commit into
Anamandla:mainfrom
mayank-dev-15:docs/readme-getting-started

Conversation

@mayank-dev-15

Copy link
Copy Markdown

Summary

Updated README.md per issue #59 acceptance criteria:

Additions

  • CI status badge: Added to README header alongside MIT license and Python version badges
  • Getting Started section: Prerequisites, clone/setup/run-tests steps, API startup command
  • Features for Contribution table: 5 beginner-friendly issues with labels, difficulty, and direct links
  • Prominent links: CONTRIBUTING.md and ROADMAP.md referenced in Getting Started

Closes #59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[A14] Update README — Getting Started section and contribution table

1 participant