Updated readme file under issue #24#42
Open
rudrikasharma15 wants to merge 2 commits into
Open
Conversation
Collaborator
|
Also add screenshots of the project in the readme. |
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
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:
Rewrote the entire README.md to align with standard open-source project structure.
Added sections for:
Project Overview
Features
Tech Stack
Installation Instructions
Project Structure
Contribution Guidelines
Issues & Enhancements
License and Acknowledgements
Included badges for GitHub stats (stars, forks, issues, license).
Improved formatting and readability.
Linked relevant files like CONTRIBUTING.md, LICENSE, and .env setup.