Skip to content

Commit 085125e

Browse files
committed
Add options table
1 parent 0025f5b commit 085125e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,20 @@ signcode.sign(options, function (error) {
4747
})
4848
```
4949

50+
## Options
51+
52+
| Name | Type | Required | Description |
53+
| :------------- | :-------- | :------- | :-------------------------- |
54+
| `cert` | `String` | Yes | Path to a certificate file. |
55+
| `path` | `String` | Yes | File path to executable to sign. |
56+
| `hash` | `Array` | No | Signature types to sign the executable with. Defaults to `['sha1', 'sha256']`. |
57+
| `key` | `String` | No | Path to a key file. Only required if `cert` is a `.pem` file. |
58+
| `name` | `String` | No | Product name to include in the signature. |
59+
| `overwrite` | `Boolean` | No | `true` to sign the executable in place, `false` to sign the file with the same path but with `-signed` at the end of it. |
60+
| `password` | `String` | No | Password to the certificate or key. |
61+
| `passwordPath` | `String` | No | Path to a file containing the password for the certificate or key. |
62+
| `site` | `String` | No | Website URL to include in the signature. |
63+
5064
## Cert helpers commands
5165

5266
These commands are helpful to when working with certificates.

0 commit comments

Comments
 (0)