Skip to content

Commit 8fb650d

Browse files
authored
docs: update README for v1.2.1 (#233)
- Updated v1.2.1 installation guide. - Formatted README to pass [super-linter](https://github.com/super-linter/super-linter) --------- Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
1 parent 79fcd26 commit 8fb650d

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The `notation-azure-kv` plugin allows you to sign the Notation-generated payload
99
The plugin supports several [credential types](./docs/plugin-config.md#credential_type).
1010

1111
## Installation the AKV plugin
12+
1213
Before you begin, make sure the latest version of the [Notation CLI has been installed](https://notaryproject.dev/docs/installation/cli/).
1314

1415
1. Navigate to the [Releases](https://github.com/Azure/notation-azure-kv/releases) page and choose a release of `notation-azure-kv`.
@@ -19,35 +20,41 @@ Before you begin, make sure the latest version of the [Notation CLI has been ins
1920
For Notation >= v1.1.0, please use [notation plugin install](https://github.com/notaryproject/notation/blob/v1.1.0/specs/commandline/plugin.md#notation-plugin-install) command to automatically install azure-kv plugin.
2021

2122
For Linux amd64:
23+
2224
```
23-
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.0/notation-azure-kv_1.2.0_linux_amd64.tar.gz --sha256sum 06bb5198af31ce11b08c4557ae4c2cbfb09878dfa6b637b7407ebc2d57b87b34
25+
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.1/notation-azure-kv_1.2.1_linux_amd64.tar.gz --sha256sum 67c5ccaaf28dd44d2b6572684d84e344a02c2258af1d65ead3910b3156d3eaf5
2426
```
2527

2628
For Linux arm64:
29+
2730
```
28-
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.0/notation-azure-kv_1.2.0_linux_arm64.tar.gz --sha256sum 49520105bdb707a7bd3a519c55cc1541fbb336ab45b665c9cb2f84593f20ff29
31+
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.1/notation-azure-kv_1.2.1_linux_arm64.tar.gz --sha256sum 77bbdfb785e22f8b1cae46392200a453a428009c4450a8dc86e10551cc06f28e
2932
```
3033

3134
For Windows amd64:
35+
3236
```
33-
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.0/notation-azure-kv_1.2.0_windows_amd64.zip --sha256sum 4478b4a323363e264924349bf7007d4201621024b0f9252e0cfde42c0938c667
37+
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.1/notation-azure-kv_1.2.1_windows_amd64.zip --sha256sum 416eb490a83e8371407cbff1abe0588c84b8cdd34372f936cb1f913b7d0da8c1
3438
```
3539

3640
For macOS amd64:
41+
3742
```
38-
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.0/notation-azure-kv_1.2.0_darwin_amd64.tar.gz --sha256sum 4b5a3480fc1d6844a69f7d9483530e9be24a74441fd571ccd5eec9f6a5337eed
43+
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.1/notation-azure-kv_1.2.1_darwin_amd64.tar.gz --sha256sum 4c360d362a9448b46f98046257d5b270b2c5b1beb04c14263e59cead898902c9
3944
```
4045

4146
For macOS arm64:
47+
4248
```
43-
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.0/notation-azure-kv_1.2.0_darwin_arm64.tar.gz --sha256sum 2bcfc0ee3ad1cbb1854110e3f02b89d46c14feb5736de37cd237b9668f378f2f
49+
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.2.1/notation-azure-kv_1.2.1_darwin_arm64.tar.gz --sha256sum bf6e07fdf309c194c99870c8a2a326fa14f9f7572fcf61948d1fcb3249ab3285
4450
```
4551

4652
**Manually install**:
4753

4854
For Linux Bash:
55+
4956
```bash
50-
version=1.2.0
57+
version=1.2.1
5158
arch=amd64
5259
install_path="${HOME}/.config/notation/plugins/azure-kv"
5360

@@ -66,8 +73,9 @@ Before you begin, make sure the latest version of the [Notation CLI has been ins
6673
```
6774

6875
For macOS Zsh:
76+
6977
```zsh
70-
version=1.2.0
78+
version=1.2.1
7179
arch=arm64
7280
install_path="${HOME}/Library/Application Support/notation/plugins/azure-kv"
7381

@@ -86,8 +94,9 @@ Before you begin, make sure the latest version of the [Notation CLI has been ins
8694
```
8795

8896
For Windows Powershell:
97+
8998
```powershell
90-
$version = "1.2.0"
99+
$version = "1.2.1"
91100
$arch = "amd64"
92101
$install_path = "${env:AppData}\notation\plugins\azure-kv"
93102
@@ -107,16 +116,18 @@ Before you begin, make sure the latest version of the [Notation CLI has been ins
107116
mkdir ${install_path}
108117
Expand-Archive -Path ${zip_file} -DestinationPath ${install_path}
109118
```
119+
110120
3. Run `notation plugin list` and confirm the `azure-kv` plugin is installed.
111121

112122
## Getting started
123+
113124
1. [Sign and verify an artifact with a self-signed Azure Key Vault certificate](docs/self-signed-workflow.md)
114125
2. [Sign and verify an artifact with a certificate signed by a trusted CA in Azure Key Vault](docs/ca-signed-workflow.md)
115126
3. [Plugin configuration](docs/plugin-config.md)
116127

117128
## Contributing
118129

119-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
130+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
120131
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
121132
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
122133

0 commit comments

Comments
 (0)