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 shields for aur and make table of contents foldable #17
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the collapsible TOC, but the badges are too many and it feels too cluttered.
Leave only the AUR 4.xxx badge but please take the others out.
Ok sure no problem, I will take it out 😄 . |
Ok as per your request I removed it 😄 . |
I meant remove all new badges except the one that points to the AUR package (the one with the version number) |
My bad, I took it in the other way. just spare me a few minutes and I will come back to you. One more thing before I make the change, I think the maintainance status shield would be necessary because this will show the reader that yes your project is well maintained and active and it is not a dead project 😄 . If you wish I can make the badges and the project title look something similar to this one: or like this one: |
I understand but I still don't like it. It doesn't take much to see if a project is maintained or not, in fact I think it's a better practice to understand what's the maintenance status of a project based on commits, PR's etc... and form your own opinion/judgement. |
Agreed 👍, Ok so in few minutes I am going to make the change. |
Ok done 👍 , you review the change again 😄 . |
README.md
Outdated
|
||
<a href="" | ||
><img | ||
alt="Maintenance" | ||
src="https://img.shields.io/maintenance/yes/2023?style=flat-square" | ||
/> | ||
</a> | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made this change here in this commit 716a797 😄 .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -7,31 +7,45 @@ | |||
[![Crates.io](https://img.shields.io/crates/v/tplay)](https://crates.io/crates/tplay) | |||
[![Crates.io](https://img.shields.io/crates/d/tplay)](https://crates.io/crates/tplay) | |||
[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE) | |||
[![Aur](https://img.shields.io/aur/version/tplay-git)](https://aur.archlinux.org/packages/tplay-git) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is ok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can merge this now 😄 .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see comments
Also a few areas to improve in your project:
|
Ok finally I realized my mistake 😄 that I had mistakenly added a maintanance status badge with html but I have now resolved the error you can review the change again.
|
I have added two shields to show the status of
aur
package and for themaintainance status
and also madetable of contents foldable
, this will make the readme feel less lengthy for the reader.