improve README with setup instructions

[kumarrahul7763]

This pull request improves the README by adding a short project description ,tech stack ,and clear local setup instructions.

Summary by CodeRabbit

• Documentation
  • Expanded README with comprehensive project information including description, technology stack, system prerequisites, step-by-step local setup instructions, and contribution guidelines to enhance onboarding and project understanding.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README.md was expanded with comprehensive project documentation including description, technology stack, prerequisites, local setup instructions, and contribution guidelines, replacing the initial minimal header content. No code logic or functional changes introduced.

Changes

Cohort / File(s)	Change Summary
Documentation README.md	Expanded with full project description, tech stack details, prerequisites, local run steps, and contribution guidelines

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Verify documentation accuracy against actual project setup and tech requirements
• Confirm all prerequisites and setup steps are complete and functional
• Check formatting and clarity of prose content

Poem

🐰 A README bloomed, once bare, now bright,
With stacks and steps and setup's light,
Prerequisites neat, contributions clear,
Doc-hopping done—no code fear! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately reflects the main change: adding comprehensive setup instructions to the README documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f06d428 and 19176ba.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~25-~25: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... Contribution Contribution are welcome .Feel free to open issues or submit pull requests.

(FEEL_FREE_TO_STYLE_ME)

🔇 Additional comments (1)

README.md (1)

1-22: Well-structured documentation with clear setup instructions.

The README provides a good foundation with a concise project description, relevant tech stack, and step-by-step local setup instructions. The overall organization and clarity are solid.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🌐 Web query:

Node.js LTS version December 2025 current stable

💡 Result:

As of December 13, 2025: Node.js 24.x is the current Active LTS (promoted to LTS on Oct 28, 2025). The non‑LTS "Current" release line is 25.x. [1][2]

Sources:
[1] Node.js security releases (Dec 15, 2025) — lists 25.x, 24.x as current lines.
[2] Node.js 24 promoted to LTS (Oct 28, 2025).

---

Update Node.js version requirement to reflect current LTS.

Node.js v16 reached end-of-life in September 2023. As of December 2025, the current LTS version is v24.x. Update line 14 to specify v20 or above (e.g., "Node.js (v20 or above)") to ensure the prerequisite reflects a supported version.

🤖 Prompt for AI Agents

In README.md around line 14, the Node.js prerequisite currently lists "Node.js
(v16 or above)" which is outdated; update that line to require a supported LTS
(e.g., "Node.js (v20 or above)" or "Node.js (v20+)" ) so the README reflects
current supported versions—edit the single line to replace v16 with v20 (or
v20+) and commit the change.

[kumarrahul7763]

Thanks for the suggestion ! Update the Node.js version requirement to reflect the current LTS for better compatibility.

[coderabbitai]

@kumarrahul7763, you're welcome! Updating to Node.js v20 or above will ensure users are running on a supported LTS version. Feel free to ping me if you'd like me to verify once the change is pushed! 🐰

    /)_/)
   (^.^)  Happy to help!
   (> <)

[kumarrahul7763]

Thanks for the review ! the Node.js version requirement is already set to v20 to reflect the current LTS.