diff --git a/README.md b/README.md index dae949493..4fd9dceeb 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,31 @@ Notation is a project to add signatures as standard items in the registry ecosys ## Table of Contents +- [Notation Quick Start](#notation-quick-start) - [Branch](#branch) - [Core Documents](#core-documents) - [Community](#community) - [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/shizhMSFT/notation/releases/download/v0.5.2/notation_0.5.2_linux_amd64.tar.gz + tar xvzf notation.tar.gz -C ~/bin notation + ``` +- 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 --trust "wabbit-networks-dev" + notation sign $IMAGE + notation list $IMAGE + notation verify $IMAGE + ``` + ## Branch [Prototype 2][prototype-2] - signing and verifying OCI artifacts, using signatures persisted [ORAS Artifacts manifests][artifact-manifest] @@ -36,4 +55,8 @@ This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foun ## License -This project is covered under the Apache 2.0 license. You can read the license [here](LICENSE). \ No newline at end of file +This project is covered under the Apache 2.0 license. You can read the license [here](LICENSE). + +[notation-releases]: https://github.com/shizhMSFT/notation/releases/tag/v0.5.0 +[artifact-manifest]: https://github.com/oras-project/artifacts-spec/blob/main/artifact-manifest.md +[cncf-distribution]: https://github.com/oras-project/distribution \ No newline at end of file