Skip to content

Commit cedac1b

Browse files
authored
Update README for 1.0.0 release. (#480)
Signed-off-by: Cody Soyland <[email protected]>
1 parent 48df3a9 commit cedac1b

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ A client library for [Sigstore](https://www.sigstore.dev/), written in Go.
44

55
[![Go Reference](https://pkg.go.dev/badge/github.com/sigstore/sigstore-go.svg)](https://pkg.go.dev/github.com/sigstore/sigstore-go)
66
[![Go Report Card](https://goreportcard.com/badge/github.com/sigstore/sigstore-go)](https://goreportcard.com/report/github.com/sigstore/sigstore-go)
7-
[![e2e-tests](https://github.com/sigstore/sigstore-go/actions/workflows/build.yml/badge.svg)](https://github.com/sigstore/sigstore-go/actions/workflows/build.yml)
7+
[![test results](https://github.com/sigstore/sigstore-go/actions/workflows/build.yml/badge.svg)](https://github.com/sigstore/sigstore-go/actions/workflows/build.yml)
8+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/sigstore/sigstore-go/badge)](https://securityscorecards.dev/viewer/?uri=github.com/sigstore/sigstore-go)
89

910
Features:
1011
- Signing and verification of [Sigstore bundles](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) compliant with Sigstore Client Spec
1112
- Verification of raw Sigstore signatures by creating bundles for them (see [conformance tests](test/conformance/main.go) for example)
1213
- Signing and verifying with a Timestamp Authority (TSA)
13-
- Signing and verifying (offline or online) with Rekor (Artifact Transparency Log)
14+
- Signing and verifying with Rekor (Artifact Transparency Log)
1415
- Structured verification results including certificate metadata
15-
- TUF support
16+
- TUF support for fetching trusted root certificates and log keys
1617
- Verification support for custom [trusted root](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_trustroot.proto)
1718
- Examples for signing and verifying artifacts
1819

@@ -24,7 +25,7 @@ Sigstore already has a canonical Go client implementation, [cosign](https://gith
2425

2526
## Status
2627

27-
`sigstore-go` is currently beta, and may have minor API changes before the 1.0.0 release. It does however pass the [`sigstore-conformance`](https://github.com/sigstore/sigstore-conformance) signing and verification test suite, and correctness is taken very seriously.
28+
`sigstore-go` is considered stable and ready for production use. It passes the [`sigstore-conformance`](https://github.com/sigstore/sigstore-conformance) signing and verification test suite.
2829

2930
## Documentation and examples
3031

@@ -36,10 +37,10 @@ Note that the CLI examples are to demonstrate how to use the library, and not in
3637

3738
## Requirements
3839

39-
Tested with:
40+
[Tested](https://github.com/sigstore/sigstore-go/blob/main/.github/workflows/build.yml) with:
4041

4142
- Unix-compatible OS and Windows
42-
- [Go 1.23](https://go.dev/doc/install)
43+
- [Go 1.23+](https://go.dev/doc/install)
4344

4445
Note that we do not provide built versions of this library, but you can see what architectures your version of `go` supports with `go tool dist list`.
4546

@@ -51,13 +52,12 @@ Tests are invoked using the standard Go testing framework. A helper exists in th
5152
$ make test
5253
```
5354

54-
## Example bundles
55-
56-
### examples/bundle-provenance.json
57-
58-
This came from https://www.npmjs.com/package/sigstore/v/1.3.0/provenance, with the outermost "bundle" key stripped off.
59-
6055
## Support
6156

6257
Bug reports are welcome via issues and questions are welcome via discussion. Please refer to [SUPPORT.md](./SUPPORT.md) for details.
6358
This project is provided as-is.
59+
60+
## Security
61+
62+
Should you discover any security issues, please refer to sigstore's [security
63+
process](https://github.com/sigstore/.github/blob/main/SECURITY.md)

0 commit comments

Comments
 (0)