Enhanced README with setup guide, contribution steps, and example usage #10220
+17
−2
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
|
@swethaswini is attempting to deploy a commit to the Excalidraw Team on Vercel. A member of the Team first needs to authorize it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This update improves the project’s documentation for new contributors and developers.
Key enhancements include:
Added a detailed setup guide for running the project locally.
Included a clear step-by-step contribution workflow to help first-time open source participants.
Added a simple React integration example under “Example Usage” for better developer onboarding.
Fixed minor grammatical and formatting issues in the README.
These changes aim to make the repository more accessible and beginner-friendly, encouraging more open-source contributions during Hacktoberfest 2025.