pim/kpkpass/README.md

0001 # KPkPass
0002
0003 Library to deal with Apple Wallet pass files.
0004
0005 ## File Format
0006
0007 Apple Wallet files are essentially ZIP files containing a JSON description of the pass,
0008 translated message catalogs and graphical assets to render the pass.
0009
0010 See [Apple's documentation](https://developer.apple.com/library/content/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/TopLevel.html)
0011 about this.
0012
0013 ## API
0014
0015 KPkPass provides means to access the content of Apple Wallet files, both via a C++ API
0016 and a QML-compatible property interface.
0017
0018 The entry point in both cases is KPkPass::Pass to load an existing pass.
0019