Skip to content

docs: Revamp README.md for better structure and visuals#38

Open
asmasayed wants to merge 4 commits intotanishq2520:mainfrom
asmasayed:main
Open

docs: Revamp README.md for better structure and visuals#38
asmasayed wants to merge 4 commits intotanishq2520:mainfrom
asmasayed:main

Conversation

@asmasayed
Copy link
Contributor

Closes #2

This pull request resolves the issue by completely revamping the README.md to make it more professional, structured, and appealing for new contributors, especially for Hacktoberfest.

Changes Made:

  • Added the project banner to the top.
  • Reorganized the content into the requested sections:
    • Project Overview
    • Features
    • Algorithms Implemented (in a Markdown table)
    • Live Demo & Demo GIF sections
    • Installation & How to Run Locally
    • How to Contribute
  • Implemented "Back to Top" links at the end of each major section to improve navigation.
  • Added a demo.gif to the assets folder and linked it in the README.

This addresses all the tasks outlined in the issue. Ready for review!

@tanishq2520
Copy link
Owner

try again to fix , cuz i have updated my repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Revamp README.md with better structure and visuals

2 participants