Skip to content

Commit

Permalink
doc: update quick start link in readme.md
Browse files Browse the repository at this point in the history
Signed-off-by: Yi Zha <[email protected]>
  • Loading branch information
yizha1 committed Nov 3, 2022
1 parent cc4e2a9 commit af3cc04
Showing 1 changed file with 1 addition and 31 deletions.
32 changes: 1 addition & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Notation is a CLI project to add signatures as standard items in the registry ec

## Table of Contents

- [Notation Quick Start](#notation-quick-start)
- [Documents](#documents)
- [Community](#community)
- [Development and Contributing](#development-and-contributing)
Expand All @@ -17,39 +16,10 @@ Notation is a CLI project to add signatures as standard items in the registry ec
- [Support](#support)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Notation Quick Start

- Install the Notation CLI from [Notation Releases][notation-releases]:

```bash
curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.11.0-alpha.4/notation_0.11.0-alpha.4_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:

```bash
docker run -d -p 5000:5000 ghcr.io/oras-project/registry:v1.0.0-rc.2
```

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

```bash
export IMAGE=localhost:5000/net-monitor:v1
docker build -t $IMAGE https://github.com/wabbit-networks/net-monitor.git#main
docker push $IMAGE
notation cert generate-test --default "wabbit-networks-dev"
notation sign --plain-http $IMAGE
notation list --plain-http $IMAGE
notation verify --plain-http $IMAGE
```

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

## Documents

- [Hello World for Notation: Local signing and verification](docs/hello-signing.md)
- [Quick start: Sign and validate a container image](https://notaryproject.dev/docs/quickstart/)
- [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
Expand Down

0 comments on commit af3cc04

Please sign in to comment.