From a13009f2eaa47ca012cab62a1ff509190ae3faf0 Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Thu, 27 Jul 2023 11:46:15 +0800 Subject: [PATCH 1/8] update READNE Signed-off-by: Feynman Zhou --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) 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 From 8c861c15a96564fc7dc08a2ea92ed459e3437020 Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Thu, 27 Jul 2023 13:11:35 +0800 Subject: [PATCH 2/8] update README Signed-off-by: Feynman Zhou --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d5a010f1..72b8b787 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ 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. +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. +> **Note** The Notation documentation 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) From 968fd0aa8aa330e0824ec28d84ef5b3a3eec3e1f Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Wed, 30 Aug 2023 11:01:50 +0800 Subject: [PATCH 3/8] resolve comments Signed-off-by: Feynman Zhou --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 72b8b787..b8ede426 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ -# Notation Golang library +# notation-go [![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) [![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 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-go offers libraries for signing, validating, uploading, and downloading OCI artifacts using [Notary Project specifications](https://github.com/notaryproject/specifications). notation-go is used by [notation](https://github.com/notaryproject/notation) CLI for signing and verifying artifacts -Notation Golang library reaches stable in July 2023 and is in active development status. +notation-go reached a stable release as of July 2023 and continues to be actively developed. -> **Note** The Notation documentation 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. +You can also find the Notary Project [README](https://github.com/notaryproject/.github/blob/main/README.md) to learn about the overall Notary Project. + +> **Note** The Notation documentation is available [here](https://notaryproject.dev/docs/). ## Table of Contents - [Core Documents](#core-documents) - [Code of Conduct](#code-of-conduct) - [License](#license) -## Core Documents +## Documentation All examples and library documentation are available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-go@main#section-documentation). From d1ae7aaebaa64b6e84b14c5652219621e89f821c Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Wed, 30 Aug 2023 11:05:01 +0800 Subject: [PATCH 4/8] refine README Signed-off-by: Feynman Zhou --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b8ede426..ff4096dc 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![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) -notation-go offers libraries for signing, validating, uploading, and downloading OCI artifacts using [Notary Project specifications](https://github.com/notaryproject/specifications). notation-go is used by [notation](https://github.com/notaryproject/notation) CLI for signing and verifying artifacts +notation-go offers libraries for signing, verifying, uploading, and downloading OCI artifacts using [Notary Project specifications](https://github.com/notaryproject/specifications). notation-go is used by [notation](https://github.com/notaryproject/notation) CLI for signing and verifying artifacts. notation-go reached a stable release as of July 2023 and continues to be actively developed. From ac70d0ae6a9ad7e88c6a120c609ab4ceccccbe59 Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Wed, 30 Aug 2023 11:06:51 +0800 Subject: [PATCH 5/8] refine README Signed-off-by: Feynman Zhou --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ff4096dc..b10b06d1 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ notation-go reached a stable release as of July 2023 and continues to be activel You can also find the Notary Project [README](https://github.com/notaryproject/.github/blob/main/README.md) to learn about the overall Notary Project. -> **Note** The Notation documentation is available [here](https://notaryproject.dev/docs/). +> **Note** The Notary Project documentation is available [here](https://notaryproject.dev/docs/). ## Table of Contents - [Core Documents](#core-documents) From 830b33b7ce0cf78050cff7f58f8c8c827689cbea Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Thu, 19 Oct 2023 11:28:45 +0800 Subject: [PATCH 6/8] Update README.md Co-authored-by: Pritesh Bandi Signed-off-by: Feynman Zhou --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b10b06d1..6c45ed8c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ You can also find the Notary Project [README](https://github.com/notaryproject/. > **Note** The Notary Project documentation is available [here](https://notaryproject.dev/docs/). ## Table of Contents -- [Core Documents](#core-documents) +- [Documentation](#documentation) - [Code of Conduct](#code-of-conduct) - [License](#license) From c54d3720cad4326a11d1fbe0728fa7d2cd6b3a86 Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Fri, 27 Oct 2023 17:39:15 +0800 Subject: [PATCH 7/8] resolve comments from maintainers Signed-off-by: Feynman Zhou --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6c45ed8c..73c7a0a0 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,24 @@ [![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) -notation-go offers libraries for signing, verifying, uploading, and downloading OCI artifacts using [Notary Project specifications](https://github.com/notaryproject/specifications). notation-go is used by [notation](https://github.com/notaryproject/notation) CLI for signing and verifying artifacts. +notation-go contains libraries for signing and verification of artifacts as per [Notary Project specifications](https://github.com/notaryproject/specifications). notation-go is being used by [notation](https://github.com/notaryproject/notation) CLI for signing and verifying artifacts. -notation-go reached a stable release as of July 2023 and continues to be actively developed. +notation-go reached a stable release as of July 2023 and continues to be actively developed and maintained. -You can also find the Notary Project [README](https://github.com/notaryproject/.github/blob/main/README.md) to learn about the overall Notary Project. +Please visit [README](https://github.com/notaryproject/.github/blob/main/README.md) to know more about Notary Project. -> **Note** The Notary Project documentation is available [here](https://notaryproject.dev/docs/). +> [!NOTE] +> The Notary Project documentation is available [here](https://notaryproject.dev/docs/). The Notary Project documentation is available [here](https://notaryproject.dev/docs/). ## Table of Contents + - [Documentation](#documentation) - [Code of Conduct](#code-of-conduct) - [License](#license) ## Documentation -All examples and library documentation are available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-go@main#section-documentation). +Library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-go). ## Code of Conduct From c4064dbf73bc99c4c452a4259ccda893801172f2 Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Fri, 27 Oct 2023 17:49:16 +0800 Subject: [PATCH 8/8] refine READmE Signed-off-by: Feynman Zhou --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73c7a0a0..e841a7fe 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ notation-go reached a stable release as of July 2023 and continues to be activel Please visit [README](https://github.com/notaryproject/.github/blob/main/README.md) to know more about Notary Project. > [!NOTE] -> The Notary Project documentation is available [here](https://notaryproject.dev/docs/). The Notary Project documentation is available [here](https://notaryproject.dev/docs/). +> The Notary Project documentation is available [here](https://notaryproject.dev/docs/). ## Table of Contents