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

Add GIF-Based Title to README.md for Enhanced Visual Appeal #173

Closed
1 task done
Karthik3904 opened this issue Oct 23, 2024 · 4 comments · Fixed by #184
Closed
1 task done

Add GIF-Based Title to README.md for Enhanced Visual Appeal #173

Karthik3904 opened this issue Oct 23, 2024 · 4 comments · Fixed by #184
Assignees
Labels
enhancement New feature or request gssoc-ext GSSoC'24 Extended Version hacktoberfest Hacktober Collaboration hacktoberfest-accepted Hacktoberfest 2024 level1 10 Points 🥇(GSSoC)

Comments

@Karthik3904
Copy link
Contributor

Is this a unique feature?

  • I have checked "open" AND "closed" issues and this is not a duplicate

Is your feature request related to a problem/unavailable functionality? Please describe.

The current README.md does not have a visually engaging title, and it may not immediately capture the attention of new users or contributors. Adding a GIF-based title would enhance the visual appeal and make the repository stand out, especially during events like Hacktoberfest where numerous repositories compete for attention.

Proposed Solution

Proposed Solution:

I propose to include a GIF-based title at the top of the README.md. The GIF would represent the project or its theme in a creative and dynamic way, while still maintaining a professional appearance. The GIF should be optimized to prevent slow page load times and should complement the repository's content.

Screenshots

Before:

  • Current plain text title/header at the top of the README.md.
    Screenshot 2024-10-23 183236

After:

  • A dynamic GIF title at the top to make the repository visually appealing and engaging.
Recording.2024-10-23.125634.mp4

Do you want to work on this issue?

Yes

If "yes" to above, please explain how you would technically implement this (issue will not be assigned if this is skipped)

I would implement the GIF-based title in the following steps:

  1. Create or Choose an Appropriate GIF:

    • I will either design a simple, looping GIF that reflects the project’s theme, or I will select a relevant GIF from a public source (ensuring no copyright issues).
    • The GIF will be visually appealing but not too large, to prevent slowing down page load times. An ideal size would be around 100-200KB, optimized for the web.
  2. Add the GIF to README.md:

    • I will edit the README.md file and include Markdown syntax to embed the GIF at the top of the file:

    • This will ensure the GIF is displayed as a title or banner, introducing the project in a more dynamic way.

  3. Test for Performance:

    • After adding the GIF, I will test the repository page's load time to ensure the GIF does not negatively impact performance.
    • If the GIF is too large, I will compress it further using tools like TinyPNG or Giphy's compression tools.
  4. Update README.md:

    • I will push the updated README.md file with the embedded GIF to the repository.
    • I’ll check the final look to ensure it’s properly aligned and the page remains user-friendly and visually appealing.

@Karthik3904 Karthik3904 added the enhancement New feature or request label Oct 23, 2024
Copy link
Contributor

Ensure the issue is not similar or previously being worked on.Thanks for your time

@Karthik3904
Copy link
Contributor Author

I have ensured that this issue is not similar to any existing or previously worked on issues. Thank you for your time and consideration!

@rohitinu6
Copy link
Owner

@Karthik3904 please go through issue #168 and let me know if you are willing to do that; if yes, then please mention your solution in #168

@rohitinu6 rohitinu6 added gssoc-ext GSSoC'24 Extended Version hacktoberfest-accepted Hacktoberfest 2024 level1 10 Points 🥇(GSSoC) hacktoberfest Hacktober Collaboration labels Oct 24, 2024
rohitinu6 added a commit that referenced this issue Oct 29, 2024
Enhance README by Adding GitHub Repository Statistics Section and Project Title GIF [Fixed #173]
Copy link
Contributor

✅ This issue has been successfully closed. Thank you for your contribution and helping us improve the project! If you have any more ideas or run into other issues, feel free to open a new one. Happy coding! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request gssoc-ext GSSoC'24 Extended Version hacktoberfest Hacktober Collaboration hacktoberfest-accepted Hacktoberfest 2024 level1 10 Points 🥇(GSSoC)
Projects
None yet
2 participants