docs: update README.md for better developer experience and sync with … #47
Conversation
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
…latest features - Add badges for version and license - Include support for src directory in features and usage - Add prerequisites and quick start guide - Improve structure and clarity for developers
|
🎉 Welcome, @HackersSpirit! Thank you for submitting a Pull Request! We're thrilled to see your contribution. Our team will review it shortly. |
gaureshpai
requested changes
Oct 3, 2025
gaureshpai
added
documentation
|
Any updates @HackersSpirit ? |
|
@HackersSpirit Do sync the changes and improve the readme based on the review |
|
Any updates on this PR. @HackersSpirit ? |
gaureshpai
removed
hacktoberfest
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes Made:
Added Badges: Included npm version and MIT license badges for better visibility.
Synced Features: Added documentation for src directory support, which was missing from the previous README.
Improved Structure:
Added a Prerequisites section specifying Node.js and package manager requirements.
Introduced a Quick Start guide for faster onboarding.
Restructured the Usage section with a clear, numbered list of prompts and their defaults.
Enhanced Clarity:
Added an example project structure section.
Updated the example walkthrough to include all prompts.
Improved overall readability and flow for developers.
Closes #26