Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update README to align with the new project brand #158

Merged
merged 6 commits into from
Nov 27, 2023
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,27 @@
[![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 implements signature generation, parsing and revocation related functionalities based on the [Notary Project specifications](https://github.com/notaryproject/specifications).

notation-core-go reached a stable release as of July 2023 and continues to be actively developed.

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
- [Documentation](#documentation)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Documentation

All 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).

## License

This project is covered under the Apache 2.0 license. You can read the license [here](LICENSE).