Skip to content

Commit

Permalink
chore(readme): Image is now smaller and it scales correctly, add link…
Browse files Browse the repository at this point in the history
…s to Apple developer docs
  • Loading branch information
ueman committed Jul 1, 2024
1 parent 148f89e commit a5fae72
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 5 deletions.
9 changes: 8 additions & 1 deletion apple_passkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Do you need to deal with `PkPass` files in your code, consider using
A PkPass file looks something like this when rendered:

<p align="center">
<img src="https://raw.githubusercontent.com/ueman/passkit/master/apple_passkit/assets/boarding_pass.png" height="400"/>
<img src="https://raw.githubusercontent.com/ueman/passkit/master/apple_passkit/assets/boarding_pass.webp"/>
</p>

## How to use it
Expand All @@ -51,6 +51,13 @@ Setup your Xcode project as described in the [documentation](https://help.apple.

After that, use `await ApplePassKit().passes()` to load your installed passes.

## Apple Wallet PassKit docs

- [Wallet Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/wallet)
- [Wallet Passes](https://developer.apple.com/documentation/walletpasses/)
- [Loyalty passes](https://developer.apple.com/wallet/loyalty-passes/)
- [Wallet Developer Guide](https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/index.html#//apple_ref/doc/uid/TP40012195-CH1-SW1)

## Contributors

Thanks a lot to all the awesome contributors:
Expand Down
Binary file removed apple_passkit/assets/boarding_pass.png
Binary file not shown.
Binary file added apple_passkit/assets/boarding_pass.webp
Binary file not shown.
11 changes: 8 additions & 3 deletions passkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,8 @@ Want to work with Apple's native PassKit APIs? Consider using [`apple_passkit`](
A PkPass file looks something like this when rendered:

<!-- ![](https://raw.githubusercontent.com/ueman/passkit/master/passkit/assets/boarding_pass.png) -->

<p align="center">
<img src="assets/boarding_pass.png" height="400"/>
<img src="https://raw.githubusercontent.com/ueman/passkit/master/passkit/assets/boarding_pass.webp"/>
</p>

## How to read a PassKit file?
Expand Down Expand Up @@ -74,6 +72,13 @@ Feel free to submit PRs for them
- Passkit creation: https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/Creating.html#//apple_ref/doc/uid/TP40012195-CH4-SW54 (as seen at the bottom of the page)
- checksum verification

## Apple Wallet PassKit docs

- [Wallet Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/wallet)
- [Wallet Passes](https://developer.apple.com/documentation/walletpasses/)
- [Loyalty passes](https://developer.apple.com/wallet/loyalty-passes/)
- [Wallet Developer Guide](https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/index.html#//apple_ref/doc/uid/TP40012195-CH1-SW1)

## Bugs and parsing issues

If you hit an issue with parsing, please create an issue and attach the PkPass (if possible)
Expand Down
Binary file removed passkit/assets/boarding_pass.png
Binary file not shown.
Binary file added passkit/assets/boarding_pass.webp
Binary file not shown.
9 changes: 8 additions & 1 deletion passkit_ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
A PkPass file looks something like this when rendered:

<p align="center">
<img src="https://raw.githubusercontent.com/ueman/passkit/master/passkit_ui/assets/boarding_pass.png" height="400"/>
<img src="https://raw.githubusercontent.com/ueman/passkit/master/passkit_ui/assets/boarding_pass.webp" />
</p>

This package contains widgets to visualize `PkPass` files as seen above with the help of [`passkit`](https://pub.dev/packages/passkit). `passkit` is a pure Dart package, which works on servers, too.
Expand Down Expand Up @@ -56,6 +56,13 @@ final pkPass = await loadPass('assets/coupon.pkpass')
Center(child: PkPassWidget(pass: pkPass))
```
## Apple Wallet PassKit docs
- [Wallet Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/wallet)
- [Wallet Passes](https://developer.apple.com/documentation/walletpasses/)
- [Loyalty passes](https://developer.apple.com/wallet/loyalty-passes/)
- [Wallet Developer Guide](https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/index.html#//apple_ref/doc/uid/TP40012195-CH1-SW1)
## Contributors
Thanks a lot to all the awesome contributors:
Expand Down
Binary file removed passkit_ui/assets/boarding_pass.png
Binary file not shown.
Binary file added passkit_ui/assets/boarding_pass.webp
Binary file not shown.

0 comments on commit a5fae72

Please sign in to comment.