Skip to content

Commit bb75d7c

Browse files
woodruffwjleightcap
authored andcommitted
README: ToC, cleanup (#412)
Signed-off-by: William Woodruff <[email protected]> Signed-off-by: William Woodruff <[email protected]>
1 parent c269dbd commit bb75d7c

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

README.md

+31-8
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,29 @@ sigstore-python
1414
You can use it to sign and verify Python package distributions, or anything
1515
else!
1616

17+
## Index
18+
19+
* [Features](#features)
20+
* [Installation](#installation)
21+
* [GitHub Actions](#github-actions)
22+
* [Usage](#usage)
23+
* [Signing](#signing)
24+
* [Verifying](#verifying)
25+
* [Generic identities](#generic-identities)
26+
* [Signatures from GitHub Actions](#signatures-from-github-actions)
27+
* [Example uses](#example-uses)
28+
* [Signing with ambient credentials](#signing-with-ambient-credentials)
29+
* [Signing with an email identity](#signing-with-an-email-identity)
30+
* [Signing with an explicit identity token](#signing-with-an-explicit-identity-token)
31+
* [Verifying against a signature and certificate](#verifying-against-a-signature-and-certificate)
32+
* [Verifying signatures from GitHub Actions](#verifying-signatures-from-github-actions)
33+
* [Licensing](#licensing)
34+
* [Community](#community)
35+
* [Contributing](#contributing)
36+
* [Code of Conduct](#code-of-conduct)
37+
* [Security](#security)
38+
* [SLSA Provenance](#slsa-provenance)
39+
1740
## Features
1841

1942
* Support for signing Python package distributions using an OpenID Connect identity
@@ -433,11 +456,19 @@ $ python -m sigstore verify github sigstore-0.10.0-py3-none-any.whl \
433456

434457
`sigstore` is licensed under the Apache 2.0 License.
435458

459+
## Community
460+
461+
`sigstore-python` is developed as part of the [Sigstore](https://sigstore.dev) project.
462+
463+
We also use a [Slack channel](https://sigstore.slack.com)!
464+
Click [here](https://join.slack.com/t/sigstore/shared_invite/zt-mhs55zh0-XmY3bcfWn4XEyMqUUutbUQ) for the invite link.
465+
436466
## Contributing
437467

438468
See [the contributing docs](https://github.com/sigstore/.github/blob/main/CONTRIBUTING.md) for details.
439469

440470
## Code of Conduct
471+
441472
Everyone interacting with this project is expected to follow the
442473
[sigstore Code of Conduct](https://github.com/sigstore/.github/blob/main/CODE_OF_CONDUCT.md).
443474

@@ -451,11 +482,3 @@ This project emits a SLSA provenance on its release! This enables you to verify
451482
of the downloaded artifacts and ensured that the binary's code really comes from this source code.
452483

453484
To do so, please follow the instructions [here](https://github.com/slsa-framework/slsa-github-generator#verification-of-provenance).
454-
455-
456-
## Info
457-
458-
`sigstore-python` is developed as part of the [`sigstore`](https://sigstore.dev) project.
459-
460-
We also use a [slack channel](https://sigstore.slack.com)!
461-
Click [here](https://join.slack.com/t/sigstore/shared_invite/zt-mhs55zh0-XmY3bcfWn4XEyMqUUutbUQ) for the invite link.

0 commit comments

Comments
 (0)