From b878664a8a55a74bb5f8ff5303ec97cbf8363e8b Mon Sep 17 00:00:00 2001 From: sarawarnock Date: Fri, 26 Feb 2021 12:01:49 -0700 Subject: [PATCH 1/3] 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. ___ From effdfd9b4068e6bdee28cb816afd9f9416946cb1 Mon Sep 17 00:00:00 2001 From: sarawarnock Date: Fri, 26 Feb 2021 13:59:09 -0700 Subject: [PATCH 2/3] edit headings for Usage Examples in README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31dea66..a9527d6 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,9 @@ ___ -## Usage Example - Folder Model +## Usage Example + +#### Folder Model ```typescript /** @@ -180,7 +182,7 @@ try { } ``` -## Usage Example - Buffer Model +#### Buffer Model ```typescript From 95967b2e7af3dcfb398e7516ac7cd6a25debdeb2 Mon Sep 17 00:00:00 2001 From: sarawarnock Date: Fri, 26 Feb 2021 14:25:31 -0700 Subject: [PATCH 3/3] fixed unpaired brackets --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a9527d6..fab0dfd 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,8 @@ try { }, // The rest will be the same as above + ... + }); } catch (err) { doSomethingWithTheError(err);