Skip to content

Commit 2d7da9b

Browse files
committed
[doc] Update packages/client/README.md
Signed-off-by: indexzero <[email protected]>
1 parent 4260488 commit 2d7da9b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

packages/client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ as well as the verification material necessary to verify the signature.
182182

183183
### verify(bundle[, payload][, options])
184184

185-
Verifies the signature in the supplied bundle.
185+
Verifies the signature in the supplied bundle. Returns a `Signer` object containing the public key and identity information from the verification.
186186

187187
- `bundle` `<Bundle>`: The Sigstore bundle containing the signature to be verified and the verification material necessary to verify the signature.
188188
- `payload` `<Buffer>`: The bytes of the artifact over which the signature was created. Only necessary when the `sign` function was used to generate the signature since the Bundle does not contain any information about the artifact which was signed. Not required when the `attest` function was used to generate the Bundle.

0 commit comments

Comments
 (0)