diff --git a/README.md b/README.md index e6da2e5e..d5a010f1 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ -# Notation +# Notation Golang library [![Build Status](https://github.com/notaryproject/notation-go/actions/workflows/build.yml/badge.svg?event=push&branch=main)](https://github.com/notaryproject/notation-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) -[![codecov](https://codecov.io/gh/notaryproject/notation-go/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation-go) +[![Codecov](https://codecov.io/gh/notaryproject/notation-go/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation-go) [![Go Reference](https://pkg.go.dev/badge/github.com/notaryproject/notation-go.svg)](https://pkg.go.dev/github.com/notaryproject/notation-go@main) -A collection of libraries for supporting Notation sign, verify, push, pull of oci artifacts. Based on Notary Project standard. +A collection of libraries for Notation, provides the ability to sign, verify, push, and pull OCI artifacts. Based on the Notary Project standard. You can develop your own client for signing and verifying artifacts by using the Notation Golang library. + +Notation Golang library reaches stable in July, 2023 and is in active development status. + +> **Note** The documentation for Notation is available [here](https://notaryproject.dev/docs/). You can also find the Notary Project [README](https://github.com/notaryproject/.github/blob/main/README.md) to learn about the overall Notary Project. ## Table of Contents - [Core Documents](#core-documents) - [Code of Conduct](#code-of-conduct) - [License](#license) - + ## Core Documents -* [Governance for Notation](https://github.com/notaryproject/notary/blob/master/GOVERNANCE.md) -* [Maintainers and reviewers list](https://github.com/notaryproject/notary/blob/master/MAINTAINERS) +All examples and library documentation are available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-go@main#section-documentation). ## Code of Conduct