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.

Sign up for GitHub

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 #7

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Update README.md #7

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5223bd7
Update README.md
fpseverino Jun 26, 2024
5b6d848
Change Swift version badge
fpseverino Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
# PassKit

[![Swift Package Manager compatible](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)
<div align="center">
<img src="https://avatars.githubusercontent.com/u/26165732?s=200&v=4" width="100" height="100" alt="avatar" />
<h1/>PassKit</h1>
<a href="https://swiftpackageindex.com/vapor-community/PassKit/0.3.0/documentation/passes">
<img src="https://design.vapor.codes/images/readthedocs.svg" alt="Documentation">
</a>
<a href="https://discord.gg/vapor"><img src="https://design.vapor.codes/images/discordchat.svg" alt="Team Chat"></a>
<a href="LICENSE"><img src="https://design.vapor.codes/images/mitlicense.svg" alt="MIT License"></a>
<a href="https://github.com/vapor-community/PassKit/actions/workflows/test.yml">
<img src="https://img.shields.io/github/actions/workflow/status/vapor-community/PassKit/test.yml?event=push&style=plastic&logo=github&label=tests&logoColor=%23ccc" alt="Continuous Integration">
</a>
<a href="https://codecov.io/github/vapor-community/PassKit">
<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" />
</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to use the same Swift version badge as the other Vapor packages? Just to have everything inline

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Do we have a Vapor "platform" badge or should I keep the SPI one? Or remove it completely?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe I could add a <br> before the two SPI badges so that they don't stick out next to the others

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have a look at https://github.com/vapor/jwt-kit/blob/main/README.md

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😅

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And when I said inline I meant to have it the same as the other Vapor packages, not literally on the same line

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, you're right

<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%3Dplatforms" alt="platforms" />
</a>
</div>
<br>

🎟️ A Vapor package which handles all the server side elements required to implement passes for Apple Wallet.

Expand Down
Loading