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

docs: update README to align with the new project brand #343

Merged
merged 12 commits into from
Nov 27, 2023
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# Notation
# 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)
[![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.
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.
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved

notation-go reached a stable release as of July 2023 and continues to be actively developed.
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved

You can also find the Notary Project [README](https://github.com/notaryproject/.github/blob/main/README.md) to learn about the overall Notary Project.
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved

> **Note** The Notary Project documentation is available [here](https://notaryproject.dev/docs/).
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved

## Table of Contents
- [Core Documents](#core-documents)
- [Documentation](#documentation)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Documentation

## Core Documents

* [Governance for Notation](https://github.com/notaryproject/notary/blob/master/GOVERNANCE.md)
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved
* [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).
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved

## Code of Conduct

Expand Down