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

Highlighted API reference and updated intro paragraph

Browse Source
This commit is contained in:
Alexander Cerutti
2019-09-08 16:51:32 +02:00
parent 410e712b49
commit 1af7eb8163
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -21,8 +21,6 @@ Pass creation and population doesn't fully happen in runtime. Pass template (mod
Both Pass template will be read and pushed as they are in the resulting .zip file, while dynamic objects will be patched against `pass.json` or generated in runtime (`manifest.json`, `signature` and translation files). Both Pass template will be read and pushed as they are in the resulting .zip file, while dynamic objects will be patched against `pass.json` or generated in runtime (`manifest.json`, `signature` and translation files).
All the static medias from both sources, will be read and pushed as they are in the resulting .zip file; dynamic object will be patched against `pass.json`, generated on runtime (`manifest.json`, `signature`) or merged if already existing (translation files). All the static medias from both sources, will be read and pushed as they are in the resulting .zip file; dynamic object will be patched against `pass.json`, generated on runtime (`manifest.json`, `signature`) or merged if already existing (translation files).
This package comes with an [API documentation](./API.md), that makes available a series of methods to customize passes.
> ⚠ Do not rely on branches outside "master", as might not be stable and will be removed once merged. > ⚠ Do not rely on branches outside "master", as might not be stable and will be removed once merged.
### Install ### Install
@@ -32,6 +30,12 @@ $ npm install passkit-generator --save
___ ___
### API Documentation
This package comes with an [API documentation](./API.md), that makes available a series of methods to create and customize passes.
___
### Looking for the previous major version? ### Looking for the previous major version?
Check the [v1 branch](https://github.com/alexandercerutti/passkit-generator/tree/v1.6.8). That branch is kept for reference only. Check the [v1 branch](https://github.com/alexandercerutti/passkit-generator/tree/v1.6.8). That branch is kept for reference only.
@@ -48,11 +52,15 @@ ___
##### Model ##### Model
The first thing you'll have to do, is to start creating a model. A model will contain all the basic pass infos, like the thumbnails, the icon, and the background and **pass.json** containing all the static infos about the pass, like Team identifier, Pass type identifier, colors, etc. The first thing you'll have to do, is to start creating a model. A model contains all the basic pass data that compose the Pass identity.
These data can be files (icon, thumbnails, ...), or pieces of information to be written in `pass.json` (Pass type identifier, Team Identifier, colors, ...).
If starting from scratch, the preferred solution is to use the folder as model, as it will allow you to access easily all the files. Also, a buffer model is mainly designed for models that are ready to be used in your application. This package allows to use two kinds of models: **Folder Model** or **Buffer Model**. If starting from scratch, the preferred solution is to use the folder as model, as it will allow you to access easily all the files. Also, a buffer model is mainly designed for models that are ready to be used in your application.
Let's suppose you have a file `model.zip` stored somewhere: you unzip it in runtime and then get the access to its files as buffers. Those buffers should be available for the rest of your application run-time and you shouldn't be in need to read them every time you are going to create a pass. Let's suppose you have a file `model.zip` stored somewhere: you unzip it in runtime and then get the access to its files as buffers. Those buffers should be available for the rest of your application run-time and you shouldn't be in need to read them every time you are going to create a pass.
> To keep a model in memory, the method [`createAbstractModel`](https://github.com/alexandercerutti/passkit-generator/blob/master/API.md#create-an-abstract-model) has been created.
___ ___
> Using the .pass extension is a best practice, showing that the directory is a pass package. > Using the .pass extension is a best practice, showing that the directory is a pass package.
@@ -133,14 +141,15 @@ ___
## Usage example ## Usage example
```typescript ```typescript
const { createPass, Pass } = require("passkit-generator"); /**
// or, for typescript * Use `const { createPass } = require("passkit-generator");`
* for usage in pure Node.js. Please note that `Pass` is only exported
* as Typescript type.
*/
import { createPass, Pass } from "passkit-generator"; import { createPass, Pass } from "passkit-generator";
let examplePass: Pass;
try { try {
examplePass = await createPass({ const examplePass = await createPass({
model: "./passModels/myFirstModel", model: "./passModels/myFirstModel",
certificates: { certificates: {
wwdr: "./certs/wwdr.pem", wwdr: "./certs/wwdr.pem",