Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #44

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Prince-Tagadiya
Copy link

@Prince-Tagadiya Prince-Tagadiya commented Oct 9, 2023

Description

This PR addresses issue #12, which is aimed at improving the README.md file for the project.

Changes Made

  • Updated the project name and added emojis for a more engaging title.
  • Added a brief project description to make it more enticing.
  • Removed the outdated image, as it is no longer used.
  • Reorganized and reformatted the content for better readability.
  • Updated badge styles and added alt text for accessibility.
  • Updated the "About" section to provide a clearer explanation of the project's purpose.
  • Simplified the list of technologies used.
  • Added emojis for sections to make the README more visually appealing.
  • Improved the "How To Use" section for clarity.
  • Provided a brief explanation of how the dynamic gradient background is generated.
  • Updated the "Contributing" section with links to the Code of Conduct and Contributing Guide.
  • Improved the "Website Demo" section by adding alt text to the demo image.
  • Updated the live website link for easier access.

Checklist

  • I have reviewed the changes made to the README.md file.
  • I have tested the documentation to ensure its accuracy.
  • The README.md file adheres to the project's style guide.
  • The documentation is organized and easy to follow.
  • I have added appropriate sections and details as mentioned in the issue.
  • This PR is ready for review.

Related Issues

Closes #12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve readme.md (always open issue, because readme file has a lot of room for improvement :)
1 participant