docs: Enhance and clarify README.md #2
Closed
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
The README.md file contained a typographical error in the installation instructions. The command `npm instal` was used instead of the correct `npm install`. This error would cause the installation to fail for any new user following the setup guide, preventing them from running the application. This commit corrects the command to ensure a smooth onboarding experience.
mauelito3
force-pushed
the
main
branch
28 times, most recently
from
3b55eea to
7ef81e5
Compare
mauelito3
force-pushed
the
main
branch
29 times, most recently
from
2704191 to
b12fb85
Compare
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.
Hi team,
This pull request provides a comprehensive update to the README.md file to improve clarity, add missing information, and make it more welcoming for new contributors.
Description of Changes
I have made the following improvements:
Corrected Typos & Grammar: Proofread the entire document and fixed several spelling mistakes and grammatical errors.
Fixed Broken Link: The link to the live demo in the header was broken and has now been corrected.
Improved Formatting: Added backticks for code snippets and commands to make them easier to read and copy.
Reason for Changes
A project's README.md is its front door. These changes are intended to make our project easier to understand, set up, and contribute to.
Request for Feedback
I would appreciate a quick review to ensure:
The new installation command is correct and clear.
The language is easy to understand for someone new to the project.
There are no other broken links or typos I may have missed.
Thanks for your review!
Checklist
[x] I have read my own changes carefully.
[x] I have tested all links in the README.md to ensure they are working.
[ ] A contrubute.md if needed