diff --git a/README.md b/README.md index 98f5bb7c2..cd7e094c6 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,13 @@ Rekór - Greek for “Record” -Rekor's goals are to provide an immutable tamper resistant ledger of metadata generated within a software projects supply chain. Rekor will enable software maintainers and build systems to record signed metadata to an immutable record. Other parties can then query said metadata to enable them to make informed decisions on trust and non-repudiation of an object's lifecycle. For more details visit the [sigstore website](https://sigstore.dev) +Rekor's goals are to provide an immutable tamper resistant ledger of metadata generated within a software projects supply chain. +Rekor will enable software maintainers and build systems to record signed metadata to an immutable record. +Other parties can then query said metadata to enable them to make informed decisions on trust and non-repudiation of an object's lifecycle. For more details visit the [sigstore website](https://sigstore.dev) -The Rekor project provides a restful API based server for validation and a transparency log for storage. A CLI application is available to make and verify entries, query the transparency log for inclusion -proof, integrity verification of the transparency log or retrieval of entries by either public key or artifact. +The Rekor project provides a restful API based server for validation and a transparency log for storage. +A CLI application is available to make and verify entries, query the transparency log for inclusion proof, +integrity verification of the transparency log or retrieval of entries by either public key or artifact. Rekor fulfils the signature transparency role of sigstore's software signing infrastructure. However, Rekor can be run on its own and is designed to be @@ -17,8 +20,23 @@ For details on CLI usage, [visit the following link](https://sigstore.dev/get_st If you're interesting in integration with Rekor, we have an [OpenAPI swagger editor](https://sigstore.dev/swagger/) +## Public Instance + A public instance of rekor can be found at [api.sigstore.dev](https://api.sigstore.dev/api/v1/log/) +**IMPORTANT**: This instance is currently operated on a best-effort basis. +We **will take the log down** and reset it with zero notice. +We will improve the stability and publish SLOs over time. + +This instance is maintained by the Rekor community. +Interested in helping operate and maintain our production CA system and Transparency Logs? +Please reach out via the [mailing list](https://groups.google.com/g/sigstore-dev). + +If you have production use-cases in mind, again - please reach out over email via the [mailing list](https://groups.google.com/g/sigstore-dev). +We are interested in helping on board you! + +## Extensibility + Rekor allows customized manifests (which term them as types), [type customization is outlined here](https://github.com/sigstore/rekor/tree/main/pkg/types). ## Contributions