mirrors/dart_pkpass
1
0
Fork 0
mirror of https://gitlab.com/TheOneWithTheBraid/dart_pkpass.git synced 2025-07-05 12:58:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source 
Signed-off-by: The one with the braid <info@braid.business>
This commit is contained in:
The one with the braid 2024-10-14 21:22:23 +02:00
parent 08bfebb09e
commit 4e25a4277e
2 changed files with 15 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -8,7 +8,7 @@ See a demo ? Check out [fWallet web](https://theonewiththebraid.gitlab.io/f_wall
## Features
- no platform specific dependencies - pure Dart
- parse any .pkpass file as blob
- parse any passbook file as blob
- checksum verification
- extract metadata
- high level lookup for assets by locale and scale, with proper fallbacks
@ -17,7 +17,7 @@ See a demo ? Check out [fWallet web](https://theonewiththebraid.gitlab.io/f_wall
## Not supported (yet)
Some parts of the PkPass specification are either not yet implemented, or not planned, such as:
Some parts of the passbook specification are either not yet implemented, or not planned, such as:
- `signature`: The detached PKCS #7 signature using Apple certificates of the manifest. Note: Checksums _are_ checked. -
Not planned, feel free to contribute.
@ -26,7 +26,7 @@ Some parts of the PkPass specification are either not yet implemented, or not pl
## Localizations
This package aims to implement PkPass localizations as well as possible. Any localizable value
This package aims to implement pkpass localizations as well as possible. Any localizable value
can be accessed using a `getLocalized...` method, e.g. `myPass.getLocalizedDescription()` taking a `Locale`
as argument. In case the requested locale is not available, the following fallbacks are used:
@ -42,10 +42,10 @@ precise fallback mechanisms.
## Barcode encodings
The PkPass standard is quite vague about the Barcode String encoding used. Technically, all IANA character set names
The passbook standard is quite vague about the Barcode String encoding used. Technically, all IANA character set names
are allowed. Since this might be some overhead to implement, the following encoders are supported by default:
- `Latin1Codec` (default according to PkPass spec) - `iso-8859-1`, also fallback onto `iso-8859` and `iso8859`
- `Latin1Codec` (default according to passbook spec) - `iso-8859-1`, also fallback onto `iso-8859` and `iso8859`
- `Utf8Codec` (most common one) - `utf-8`, also fallback onto `utf8`
The supported encoders can be extended by adding a `String` `Encoder` pair to `PassBarcode.supportedCodecs`.
@ -53,7 +53,7 @@ The supported encoders can be extended by adding a `String` `Encoder` pair to `P
## Dependencies and compatibility
Any package should keep its dependencies as minimal as possible. Sometimes, there are specifications making this
difficult. The PkPass spec unfortunately is a very complex one, requiring support of many standards and formats.
difficult. The passbook spec unfortunately is a very complex one, requiring support of many standards and formats.
The following dependencies are used to correctly parse the PkPass file into a relevant Dart representation.

11
pubspec.yaml
View file

@ -1,5 +1,5 @@
name: pkpass
description: A Dart native pkpass parsing library supporting checksum verification, barcode parsing, localization and much more.
description: A Dart native passbook parsing library supporting checksum verification, barcode parsing, localization and much more.
version: 2.1.2
repository: https://gitlab.com/TheOneWithTheBraid/dart_pkpass.git
homepage: https://gitlab.com/TheOneWithTheBraid/dart_pkpass
@ -7,6 +7,7 @@ issue_tracker: https://gitlab.com/TheOneWithTheBraid/dart_pkpass/-/issues
funding:
- https://www.buymeacoffee.com/braid
environment:
sdk: ^3.1.0
@ -18,7 +19,13 @@ dependencies:
http: ^1.0.0
intl: ">=0.17.0 <1.0.0"
topics:
- wallet
- pkpass
- passbook
dev_dependencies:
import_sorter: ^4.6.0
lints: ">=2.0.0 <5.0.0"
lints: ^5.0.0
test: ^1.21.0