marcogll/passkit-generator
1
0
Fork 0
mirror of https://github.com/marcogll/passkit-generator.git synced 2026-03-15 18:25:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Alexander Cerutti
2019-01-29 20:28:40 +01:00
parent 34d4879438
commit 3170a5e013
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
API.md
View File

@@ -75,10 +75,10 @@ var pass = new Pass(options);
| options | Object | The options to create the pass | false | - | options | Object | The options to create the pass | false | -
| options.model | String/Path | The model path to be used to generate a new model. | false | - | options.model | String/Path | The model path to be used to generate a new model. | false | -
| options.certificates | Object | The certificate object containing the paths to certs files. | false | - | options.certificates | Object | The certificate object containing the paths to certs files. | false | -
| options.certificates.wwdr | String/Path | The path to Apple WWDR certificate. | false | - | options.certificates.wwdr | String/Path | The path to Apple WWDR certificate or its content. | false | -
| options.certificates.signerCert | String/Path | The path to Developer certificate file. | false | - | options.certificates.signerCert | String/Path | The path to Developer certificate file or its content. | false | -
| options.certificates.signerKey | Object | The object containing developer certificate's key and passphrase. | false | - | options.certificates.signerKey | Object/String | The object containing developer certificate's key and passphrase. If string, it can be the path to the key file or its content. If object, must have `keyFile` key and might need `passphrase`. | false | -
| options.certificates.signerKey.keyFile | String/Path | The path to developer certificate key. | false | - | options.certificates.signerKey.keyFile | String/Path | The path to developer certificate key or its content. | false | -
| options.certificates.signerKey.passphrase | String \| Number | The passphrase to use to unlock the key. | false | - | options.certificates.signerKey.passphrase | String \| Number | The passphrase to use to unlock the key. | false | -
| options.overrides | Object | Dictionary containing all the keys you can override in the pass.json file and does not have a method to get overridden. | true | { } | options.overrides | Object | Dictionary containing all the keys you can override in the pass.json file and does not have a method to get overridden. | true | { }
| options.shouldOverwrite | Boolean | Setting this property to false, will make properties in `overrides` and fields to be pushed along with the ones added through methods to the existing ones in pass.json. | true | true | options.shouldOverwrite | Boolean | Setting this property to false, will make properties in `overrides` and fields to be pushed along with the ones added through methods to the existing ones in pass.json. | true | true

2
README.md
View File

@@ -5,6 +5,8 @@
<br> <br>
<br> <br>
<p align="center">Simple Node.js interface to generate customized <a href="https://developer.apple.com/wallet/">Apple Wallet Passes</a> for iOS.</p> <p align="center">Simple Node.js interface to generate customized <a href="https://developer.apple.com/wallet/">Apple Wallet Passes</a> for iOS.</p>
![](https://img.shields.io/npm/v/passkit-generator.svg?label=passkit-generator)
</div> </div>
<br> <br>