Skip to content

Commit

Permalink
add better description and images
Browse files Browse the repository at this point in the history
  • Loading branch information
ueman committed Jul 1, 2024
1 parent c375149 commit 2bee08c
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 5 deletions.
19 changes: 18 additions & 1 deletion passkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,24 @@ PassKit allows you to work with Apple's PkPass files. This is a pure Dart librar

In order to show PassKit files in Flutter, use the [`passkit_ui`](https://pub.dev/packages/passkit_ui) package, which includes ready made widgets.

Want to work with Apple's PassKit APIs? Consider using [`apple_passkit`](https://pub.dev/packages/apple_passkit).
Want to work with Apple's native PassKit APIs? Consider using [`apple_passkit`](https://pub.dev/packages/apple_passkit).

## What is PassKit?

> Passes are a digital representation of information that might otherwise be printed on small pieces of paper or plastic. They let users take an action in the physical world. Passes can contain images and a barcode, and you can update passes using push notifications on iOS.
>
> This technology consists of three main components:
> - A package format for creating passes.
> - A web service API for updating passes, implemented on your server.
> - An API used by your apps to interact with the user’s pass library.
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"/>
</p>

## How to read a PassKit file?

Expand Down
Binary file added passkit/assets/boarding_pass.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions passkit/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ issue_tracker: https://github.com/ueman/passkit/issues
topics:
- passkit
- pkpass
screenshots:
- description: "Screenshot of a PkPass of the boarding pass type"
path: assets/boarding_pass.png

environment:
sdk: ">=3.4.3 <4.0.0"
Expand Down
23 changes: 19 additions & 4 deletions passkit_ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,27 @@
> 🚧 API is subject to change! 🚧
> Not all pass types are yet supported. Not ready for production use.
This package contains widgets to visualize `PkPass` files with the help of [`passkit`](https://pub.dev/packages/passkit). `passkit` is a pure Dart package, which also works on servers.
## What is PassKit?

This package does intentionally not support showing the "backside" of a `PkPass` file, since there are a lot of features that depend on application logic.
Those include among other things: sharing a pass, deleting a pass, having the ability to open URLs, emails and phone numbers.
> Passes are a digital representation of information that might otherwise be printed on small pieces of paper or plastic. They let users take an action in the physical world. Passes can contain images and a barcode, and you can update passes using push notifications on iOS.
>
> This technology consists of three main components:
> - A package format for creating passes.
> - A web service API for updating passes, implemented on your server.
> - An API used by your apps to interact with the user’s pass library.
Want to work with Apple's PassKit APIs? Consider using [`apple_passkit`](https://pub.dev/packages/apple_passkit).
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"/>
</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.

This package does intentionally not support showing the "backside" of a `PkPass` file, since that requires a lot of features that depend on application logic.
Those include, among other things: sharing a pass, deleting a pass, having the ability to open URLs, emails and phone numbers.

You want to work with Apple's native PassKit APIs? Consider using [`apple_passkit`](https://pub.dev/packages/apple_passkit) in addition to this.

## How to use it?

Expand Down
Binary file added passkit_ui/assets/boarding_pass.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions passkit_ui/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ issue_tracker: https://github.com/ueman/passkit/issues
topics:
- passkit
- pkpass
screenshots:
- description: "Screenshot of a PkPass of the boarding pass type"
path: assets/boarding_pass.png

environment:
sdk: ">=3.4.3 <4.0.0"
Expand Down

0 comments on commit 2bee08c

Please sign in to comment.