From b878664a8a55a74bb5f8ff5303ec97cbf8363e8b Mon Sep 17 00:00:00 2001 From: sarawarnock Date: Fri, 26 Feb 2021 12:01:49 -0700 Subject: [PATCH] added Buffer Model to README --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f289445..31dea66 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ ___ -## Usage example +## Usage Example - Folder Model ```typescript /** @@ -180,6 +180,29 @@ try { } ``` +## Usage Example - Buffer Model + +```typescript + +import { createPass, Pass } from "passkit-generator"; + +try { + const examplePass = await createPass({ + model: { + "thumbnail": Buffer.from([ ... ]), + "icon": Buffer.from([ ... ]), + "pass.json": Buffer.from([ ... ]), + "it.lproj/pass.strings": Buffer.from([ ... ]) + }, + + // The rest will be the same as above + +} catch (err) { + doSomethingWithTheError(err); +} + +``` + For more complex usage examples, please refer to [examples](https://github.com/alexandercerutti/passkit-generator/tree/master/examples) folder. ___