Skip to content

Commit 97f80e2

Browse files
committed
Addressing comments.
Signed-off-by: hayleycd <[email protected]>
1 parent e959696 commit 97f80e2

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

content/en/language_clients/javascript/overview.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,20 @@ npm install sigstore
4141

4242
### Signing example
4343

44-
The following function will sign the file `foo.txt`:
45-
4644
```console
47-
sign('foo.txt');
48-
```
45+
const bundle = await sign(Buffer.from('hello world'));
46+
```
4947

5048
There are a number of optional arguments that can be used with the sign function. Additional information is available in the [project repository](https://github.com/sigstore/sigstore-js/tree/main/packages/client#signpayload-options).
5149

52-
The sign function will return a Sigstore bundle (`foo.txt.sigstore.json`) which includes the signature and the necessary verification material.
50+
The sign function will return a JSON-encoded Sigstore bundle which includes the signature and the necessary verification material.
5351

5452
### Verifying example
5553

56-
The following function will verify the file `foo.txt`:
54+
The following function will verify the previously signed message:
5755

5856
```console
59-
verify('foo.txt.sigstore.json', payload='foo.txt', certificateIssuer='odicIssuerURL', certificateIdentityEmail='myEmail@example.com' )
57+
verify(bundle, Buffer.from('hello world'), { certificateIssuer: 'https://token.actions.githubusercontent.com/' });
6058
```
6159

6260
More information on optional arguments can be found in the [project documentation](https://github.com/sigstore/sigstore-js/tree/main/packages/client#verifybundle-payload-options)

0 commit comments

Comments
 (0)