Skip to content

Commit 6567a16

Browse files
committed
update option method add description and add directory structure on usage
1 parent 5ba8b57 commit 6567a16

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,28 @@ To download your pass signing certificate, do the following:
3838
| signCert | String | Required | Path to Pass Signing Certificate. |
3939
| password | String | Optional | The Password of the Pass Signing Certificate. |
4040
### Method: add
41-
| Name | Type | Required | Description |
42-
|----------|------------------|----------|---------------------------|
43-
| filename | String | Required | Filename with extension. |
44-
| data | Buffer \| String | Required | File contents. |
45-
| language | String | Optional | Language Code (ISO 639-1) |
41+
| Name | Type | Required | Description |
42+
|----------|------------------|----------|------------------------------------------------|
43+
| filename | String | Required | Filename with extension. |
44+
| data | Buffer \| String | Required | File path as string or file content as buffer. |
45+
| language | String | Optional | Language Code (ISO 639-1). |
4646

4747
## Usage
48+
Directory structure of a sample pass.
49+
```
50+
.
51+
└── Sample.pass/
52+
├── icon.png
53+
54+
├── pass.json
55+
├── en.lproj/
56+
│ ├── logo.png
57+
│ └── [email protected]
58+
└── th.lproj/
59+
├── logo.png
60+
61+
```
62+
4863
```js
4964
const PassGenerator = require('passgenerator-js')
5065

@@ -55,16 +70,16 @@ const passGenerator = new PassGenerator({
5570

5671
const pass = passGenerator.createPass()
5772

58-
pass.add('icon.png', './Generic.pass/icon.png')
59-
pass.add('[email protected]', './Generic.pass/[email protected]')
73+
pass.add('icon.png', './Sample.pass/icon.png')
74+
pass.add('[email protected]', './Sample.pass/[email protected]')
6075

61-
pass.add('logo.png', './Generic.pass/logo.png')
62-
pass.add('[email protected]', './Generic.pass/[email protected]')
76+
pass.add('pass.json', './Sample.pass/pass.json')
6377

64-
pass.add('logo.png', './Generic.pass/th.lproj/logo.png', 'th')
65-
pass.add('[email protected]', './Generic.pass/th.lproj/[email protected]', 'th')
78+
pass.add('logo.png', './Sample.pass/en.lproj/logo.png', 'en')
79+
pass.add('[email protected]', './Sample.pass/en.lproj/[email protected]', 'en')
6680

67-
pass.add('pass.json', './Generic.pass/pass.json')
81+
pass.add('logo.png', './Sample.pass/th.lproj/logo.png', 'th')
82+
pass.add('[email protected]', './Sample.pass/th.lproj/[email protected]', 'th')
6883

6984
const pkpass = pass.generate()
7085

0 commit comments

Comments
 (0)