Skip to content

Commit

Permalink
python: doc tweaks (#340)
Browse files Browse the repository at this point in the history
Signed-off-by: William Woodruff <william@trailofbits.com>
  • Loading branch information
woodruffw authored Oct 29, 2024
1 parent 29e6125 commit 9756f33
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions content/en/language_clients/python/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Full project documentation can be found in the [sigstore-python](https://github.
python -m pip install sigstore
```

Optionally, you can install `sigstore` and all its dependencies with [hash-checking mode](https://pip.pypa.io/en/stable/topics/secure-installs/#hash-checking-mode) enabled. Learn more about it in our [project documentation](https://github.com/sigstore/sigstore-python#installation)
Optionally, you can install `sigstore` and all its dependencies with [hash-checking mode](https://pip.pypa.io/en/stable/topics/secure-installs/#hash-checking-mode) enabled. Learn more about it in the [project documentation](https://github.com/sigstore/sigstore-python#installation).

### GitHub Action Installation

Expand All @@ -48,14 +48,16 @@ jobs:
### Signing example
For this example, we will sign a a file named `foo.txt`. [`sigstore`](https://pypi.org/project/sigstore/) will use OpenID Connect (OIDC) to veryify your email address.
For this example, we will sign a a file named `foo.txt`. [`sigstore`](https://pypi.org/project/sigstore/) will use OpenID Connect (OIDC) to verify your email address.

Use the following command to sign `foo.txt`:

```console
sigstore sign foo.txt
```

This will produce `foo.txt.sigstore.json` for subsequent verification.

### Verifying example

To verify the signature on `foo.txt` run the following command:
Expand Down

0 comments on commit 9756f33

Please sign in to comment.