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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a13009f
update READNE
FeynmanZhou Jul 27, 2023
8c861c1
update README
FeynmanZhou Jul 27, 2023
968fd0a
resolve comments
FeynmanZhou Aug 30, 2023
5b11793
Merge branch 'main' of https://github.com/notaryproject/notation-go
FeynmanZhou Aug 30, 2023
d1ae7aa
refine README
FeynmanZhou Aug 30, 2023
ac70d0a
refine README
FeynmanZhou Aug 30, 2023
830b33b
Update README.md
Oct 19, 2023
4a79ec0
Merge branch 'main' into main
Oct 19, 2023
c54d372
resolve comments from maintainers
FeynmanZhou Oct 27, 2023
a0f3259
Merge branch 'main' into main
Oct 27, 2023
c4064db
refine READmE
FeynmanZhou Oct 27, 2023
0ee2de0
Merge branch 'main' of https://github.com/notaryproject/notation-go
FeynmanZhou Nov 23, 2023
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
23 changes: 15 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
# 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 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 and maintained.

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

## 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)
* [Maintainers and reviewers list](https://github.com/notaryproject/notary/blob/master/MAINTAINERS)
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved
Library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-go).

## Code of Conduct

Expand Down
Loading