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

fix broken links and refine wording in README.md #332

Merged
merged 1 commit into from
Sep 23, 2022
Merged

fix broken links and refine wording in README.md #332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 11 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![codecov](https://codecov.io/gh/notaryproject/notation/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation)

Notation is a CLI project to add signatures as standard items in the registry ecosystem, and to build a set of simple tooling for signing and verifying these signatures. This should be viewed as similar security to checking git commit signatures, although the signatures are generic and can be used for additional purposes. Notation is an implementation of the [Notary V2 specifications][notaryv2-specs].
Notation is a CLI project to add signatures as standard items in the registry ecosystem, and to build a set of simple tooling for signing and verifying these signatures. This should be viewed as similar security to checking git commit signatures, although the signatures are generic and can be used for additional purposes. Notation is an implementation of the [Notary v2 specifications][notaryv2-specs].

## Table of Contents

Expand All @@ -17,17 +17,17 @@ Notation is a CLI project to add signatures as standard items in the registry ec

## Notation Quick Start

- Install the Notation CLI from [Notation Releases][notation-releases]
- Install the Notation CLI from [Notation Releases][notation-releases]:
```bash
curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.10.0-alpha.3/notation_0.10.0-alpha.3_linux_amd64.tar.gz
tar xvzf notation.tar.gz -C ~/bin notation
```
- Run a local instance of the [CNCF Distribution Registry][cncf-distribution], with [ORAS Artifacts][artifact-manifest] support.
- Run a local instance of the [CNCF Distribution Registry][cncf-distribution], with [ORAS Artifacts][artifact-manifest] support:
```bash
docker run -d -p 5000:5000 ghcr.io/oras-project/registry:v1.0.0-rc
```

- Build, Push, Sign, Verify the `net-monitor` software
- Build, push, sign, verify the `net-monitor` software:

```bash
export IMAGE=localhost:5000/net-monitor:v1
Expand All @@ -39,15 +39,14 @@ Notation is a CLI project to add signatures as standard items in the registry ec
notation verify --plain-http $IMAGE
```

Signatures are persisted as [ORAS Artifacts manifests][artifact-manifest].
> Note: Signatures are persisted as [ORAS Artifacts manifests][artifact-manifest].


## Documents

- [Hello World for Notation: Local signing and verification](docs/hello-signing.md)
- [Build, sign, and verify container images using Notary and Azure Key Vault](https://docs.microsoft.com/azure/container-registry/container-registry-tutorial-sign-build-push)


## Community

### Development and Contributing
Expand All @@ -59,8 +58,8 @@ Signatures are persisted as [ORAS Artifacts manifests][artifact-manifest].

### Notary v2 Community Meeting

- Mondays 5-6pm pacific time, 8-9pm US Eastern, 8-9am Shanghai
- Thursdays 9-10am pacific time, 12pm US Eastern, 5pm UK
- Mondays 5-6 PM Pacific time, 8-9 PM US Eastern, 8-9 AM Shanghai
- Thursdays 9-10 AM Pacific time, 12 PM US Eastern, 5 PM UK

Join us at [Zoom Dial-in link](https://zoom.us/my/cncfnotaryproject) / Passcode: 77777. Please see the [CNCF Calendar](https://www.cncf.io/calendar/) for community meeting details. Meeting notes are captured on [hackmd.io](https://hackmd.io/_vrqBGAOSUC_VWvFzWruZw).

Expand All @@ -80,7 +79,7 @@ This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foun

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

[Notation Releases]: https://github.com/notaryproject/notation/releases
[Notary v2 Specs]: https://github.com/notaryproject/notaryproject
[ORAS artifact-manifest]: https://github.com/oras-project/artifacts-spec/blob/main/artifact-manifest.md
[CNCF Distribution]: https://github.com/oras-project/distribution
[notation-releases]: https://github.com/notaryproject/notation/releases
[notaryv2-specs]: https://github.com/notaryproject/notaryproject
[artifact-manifest]: https://github.com/oras-project/artifacts-spec/blob/main/artifact-manifest.md
[cncf-distribution]: https://github.com/oras-project/distribution