Update README.md #7
Conversation
There was a problem hiding this comment.
So besides the badge I must say I'm not a fan of the naming in this package. Looking at the README, an example is the PassKitPass model: IMO elements in a package shouldn't contain the package's name in their name. For example, PassKitPass, if explicated, would be PassKit.PassKitPass which is just ugly. I think it should be just named Pass, the same goes for PassKitPassData (should be PassData) and PassKitRegistration (should just be PassRegistration). Passes isn't PassKitPasses so I don't see why the rest should be. There might be more similarities which don't show up at a glance. I'm not going to block the PR as it's not an issue with the PR itself but yeah
README.md
Outdated
| <img src="https://img.shields.io/codecov/c/github/vapor-community/PassKit?style=plastic&logo=codecov&label=codecov"> | ||
| </a> | ||
| <a href="https://swiftpackageindex.com/vapor-community/PassKit"> | ||
| <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvapor-community%2FPassKit%2Fbadge%3Ftype%3Dswift-versions" alt="versions" /> |
There was a problem hiding this comment.
We might want to use the same Swift version badge as the other Vapor packages? Just to have everything inline
There was a problem hiding this comment.
Ok. Do we have a Vapor "platform" badge or should I keep the SPI one? Or remove it completely?
There was a problem hiding this comment.
Or maybe I could add a <br> before the two SPI badges so that they don't stick out next to the others
There was a problem hiding this comment.
Have a look at https://github.com/vapor/jwt-kit/blob/main/README.md
There was a problem hiding this comment.
Yeah, I took heavy inspiration from it 😂 and there isn't a platform badge similar to the one from SPI.
So what do you suggest, to remove the SPI platform badge and substitute the version one, or to put both on a new line?
There was a problem hiding this comment.
Oh the platform one sorry, I mean feel free to keep it if you want but it should be pretty self-explanatory that it's for the server as it is a Vapor package after all 😅
There was a problem hiding this comment.
And when I said inline I meant to have it the same as the other Vapor packages, not literally on the same line
Yeah, it's a problem. I've started renaming something with the previous PR, but I'll finish the work when I add the |
Add shields.io badges to the README