Thoughts on a slight change to the README

[SecondThundeR]

"Problem"

Due to a new GitHub feature from March that automatically generates a table of contents for README files, there is an empty item in the current README's table of contents that directs to the icon anchor, which looks a little strange.

Example:

Here is the icon's anchor

Here is an empty item due to empty header

Solution

At the moment I see two workarounds:

• "Low Effort" Method - Involves disabling the ToC in the repository settings
• "Beautification" Method - Edit the README to make the table of contents look normal

The second method can be done by removing anchor from the icon and adding a main header with the project name

Example:

Here are removed anchor from icon and added header

Table of Contents now looks fine

We can also add a center alignment that looks like this:

In my personal experience, many large repositories prefer to do centering, but here it is up to everyone's personal preference.

Conclusion

This "problem" does not affect the work with the repository, but from a visual point of view, when opening the ToC, an empty item looks a little strange and can attract attention. Is the README worth these changes, or is it preferable to leave it as it is? (If so, I can make a PR with these changes)

[Torxed]

I would very much welcome this change.
As long as the content remains roughly the same I wouldn't mind a PR! :D

I'm torn on the center vs non centered logo so maybe hold off on that one?
My brain says yes! Which usually means do the opposite when it comes to designs hehe.

[SecondThundeR]

I can comment out the part for the centered logo, so when the time comes for this decision, you can simply uncomment it and logo will be centered

[Torxed]

That sounds like magic to my ears! No rush but I'll be looking forward to that PR!