📖 Improve README: modernize layout, clarify setup & contribution flow #5337
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 PR updates the README.md to make the repository more approachable for contributors and maintainers.
Changes include:
Replaced boilerplate text with a clear explanation of the project’s purpose
Modernized the look with consistent headings (including emoji for readability)
Added step-by-step instructions for running the site locally (clone, install, serve)
Clarified how to add new projects via _data/projects YAML files
Included badges for build status, license, and contributions
Highlighted the Code of Conduct and community expectations
Simplified test and validation instructions
Why this helps:
Provides a better “first impression” for newcomers
Reduces friction for first-time contributors
Aligns the documentation with the mission of Up-for-Grabs.net — making open source contributions easier to discover and more welcoming