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

Updated documentation

Browse Source
This commit is contained in:
Alexander Cerutti
2018-12-08 17:54:36 +01:00
parent bad4b01fad
commit 96e2b628fe
2 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
API.md
View File

@@ -419,10 +419,9 @@ pass.load(resource, name);
**Description**:
Sets the resources to be downloaded in runtime to be pushed in the pass.
Use `name` param to give your downloaded file a name or to provide the folder path it will be pushed into (with the name, _obv._).
Give `name` param a name for your file or the folder path it will be pushed into (with the name, _obv._) - see the examples.
Requests are not cached and load method can only load pictures right now (no other types should be required.);
Requests are not cached and load method can only load pictures right now (no other types should be required). In case of conflict between downloaded files and model files, downloaded files will have the priority and will be putted in the zip file.
When in debug mode, file header is shown.

4
README.md
View File

@@ -12,9 +12,9 @@
This package was created with a specific architecture in mind: **application** and **model**, to split as much as possible static objects (such as logo, background, icon, etc.) from dynamic ones (translations, barcodes, serialNumber, ...).
Actually, pass template (model) creation and population doesn't happen within the application in runtime. Pass template is a folder in _your application directory_ (but nothing will stop you from putting it outside), that will contain all the objects needed (static medias) and structure to make a pass work.
Actually, pass creation and population doesn't fully happen within the application in runtime. Pass template is a folder in, for example, _your application directory_ (but nothing will stop you from putting it outside), that will contain all the objects needed (static medias) and structure to make a pass work.
Pass template will be read and pushed as is in the resulting .zip file along with web-fetched medias, while dynamic objects will be patched against `pass.json` or generated in runtime (`manifest.json`, `signature` and translation files).
Pass template will be read and pushed as is in the resulting .zip file along with web-fetched medias (also considered dynamic objects), while dynamic objects will be patched against `pass.json` or generated in runtime (`manifest.json`, `signature` and translation files).
This package comes with an [API documentation](./API.md), that makes available a series of methods to customize passes.