From 766c454bf4ed493a4703af398917f11a1503fc6e Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Thu, 27 Jul 2023 13:09:03 +0800 Subject: [PATCH 1/4] update README Signed-off-by: Feynman Zhou --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b78da47d..71c92a9d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ -# notation-core-go +# Notation-core-go library [![Build Status](https://github.com/notaryproject/notation-core-go/actions/workflows/build.yml/badge.svg?event=push&branch=main)](https://github.com/notaryproject/notation-core-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) [![codecov](https://codecov.io/gh/notaryproject/notation-core-go/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation-core-go) [![Go Reference](https://pkg.go.dev/badge/github.com/notaryproject/notation-core-go.svg)](https://pkg.go.dev/github.com/notaryproject/notation-core-go@main) -Contains support for Notary Project signature envelope, and format specific implementation +Notation-core-go library provides specific implementation for Notary Project signature envelope, signature format, and OCSP revocation check. + +Notation-core-go library reaches stable in July 2023 and is in active development status. + +> **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) +- [Code of Conduct](#code-of-conduct) +- [License](#license) + +## Core Documents + +All library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-core-go). + +## Code of Conduct + +This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for further details. + +## License + +This project is covered under the Apache 2.0 license. You can read the license [here](LICENSE). From 9b9c75f377372c507220f89eda750366a9047f6e Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Wed, 30 Aug 2023 11:12:04 +0800 Subject: [PATCH 2/4] resolve comments Signed-off-by: Feynman Zhou --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 71c92a9d..30071b35 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,29 @@ -# Notation-core-go library +# notation-core-go [![Build Status](https://github.com/notaryproject/notation-core-go/actions/workflows/build.yml/badge.svg?event=push&branch=main)](https://github.com/notaryproject/notation-core-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) [![codecov](https://codecov.io/gh/notaryproject/notation-core-go/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation-core-go) [![Go Reference](https://pkg.go.dev/badge/github.com/notaryproject/notation-core-go.svg)](https://pkg.go.dev/github.com/notaryproject/notation-core-go@main) -Notation-core-go library provides specific implementation for Notary Project signature envelope, signature format, and OCSP revocation check. +notation-core-go implements signature generation, parsing and revocation related functionalities based on the [Notary Project specifications](https://github.com/notaryproject/specifications). -Notation-core-go library reaches stable in July 2023 and is in active development status. +notation-core-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 Notary Project 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 library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-core-go). ## Code of Conduct -This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for further details. +This project follows the [Notary Project Code of Conduct](https://github.com/notaryproject/.github/blob/main/CODE_OF_CONDUCT.md). ## License From 84d5d77155a04a9eba07e353e79bd1e395c1152e Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Thu, 19 Oct 2023 11:25:43 +0800 Subject: [PATCH 3/4] Refine 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 30071b35..97fab51c 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 bd2c97242780fcad4aa54d9bf23410f521431b2f Mon Sep 17 00:00:00 2001 From: Feynman Zhou Date: Fri, 27 Oct 2023 17:48:41 +0800 Subject: [PATCH 4/4] resolve comments from maintainers Signed-off-by: Feynman Zhou --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 97fab51c..085772bf 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,14 @@ [![codecov](https://codecov.io/gh/notaryproject/notation-core-go/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation-core-go) [![Go Reference](https://pkg.go.dev/badge/github.com/notaryproject/notation-core-go.svg)](https://pkg.go.dev/github.com/notaryproject/notation-core-go@main) -notation-core-go implements signature generation, parsing and revocation related functionalities based on the [Notary Project specifications](https://github.com/notaryproject/specifications). +notation-core-go provides core crypto functionality for notation-go and implements signature generation, parsing and revocation related functionalities based on the [Notary Project specifications](https://github.com/notaryproject/specifications). It also provides validation functionality for certificate and certificate chain. -notation-core-go reached a stable release as of July 2023 and continues to be actively developed. +notation-core-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/). ## Table of Contents - [Documentation](#documentation) @@ -19,11 +20,11 @@ You can also find the Notary Project [README](https://github.com/notaryproject/. ## Documentation -All library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-core-go). +Library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-core-go). ## Code of Conduct -This project follows the [Notary Project Code of Conduct](https://github.com/notaryproject/.github/blob/main/CODE_OF_CONDUCT.md). +This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for further details. ## License