Skip to content

Commit 964f00b

Browse files
committed
docs(readme): update description
1 parent 1f3bcaa commit 964f00b

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PGP Verify Jar
22

3-
Multi-platform Docker container to verify jar files PGP signatures.
3+
Multi-platform Docker container to verify JAR files PGP signatures.
44

55
[![Dockerfile](https://img.shields.io/badge/GitHub-Dockerfile-blue)](pgp-verify-jar/Dockerfile)
66
[![ShellCheck](https://github.com/leplusorg/docker-pgp-verify-jar/workflows/ShellCheck/badge.svg)](https://github.com/leplusorg/docker-pgp-verify-jar/actions?query=workflow:"ShellCheck")
@@ -14,7 +14,7 @@ Multi-platform Docker container to verify jar files PGP signatures.
1414
## Goal and limitations
1515

1616
The goal of this Docker container image is to provide an easy way to
17-
verify jar files signatures. Currently it can only verify files that
17+
verify JAR files signatures. Currently it can only verify files that
1818
it downloads from a Maven repository that doesn't require
1919
authentication and that use a certificate issues by a trusted public
2020
CA.
@@ -29,7 +29,7 @@ Gradle even has this feature
2929

3030
## Examples
3131

32-
Assuming that you want to see the signature of two jar files:
32+
Assuming that you want to see the signature of two JAR files:
3333

3434
```bash
3535
docker run --rm leplusorg/pgp-verify-jar org.leplus:ristretto:2.0.0 junit:junit:4.13.1
@@ -58,7 +58,7 @@ docker run --rm leplusorg/pgp-verify-jar --keyserver=pgp.mit.edu org.leplus:rist
5858
```
5959

6060
> [!WARNING]
61-
> Note that this will show you the jar files signature information but if
61+
> Note that this will show you the JAR files signature information but if
6262
> you use a public keyserver, it doesn't provide any guarantee since
6363
> anybody can upload a key to a public keyserver and claim that it is
6464
> owned by anyone (neither the name nor the email address associated
@@ -134,11 +134,11 @@ Replace `linux/amd64` by the desired platform (`linux/amd64`, `linux/arm64` etc.
134134

135135
[Sigstore](https://docs.sigstore.dev) is trying to improve supply
136136
chain security by allowing you to verify the origin of an
137-
artifcat. You can verify that the jar that you use was actually
137+
artifcat. You can verify that the image that you use was actually
138138
produced by this repository. This means that if you verify the
139-
signature of the ristretto jar, you can trust the integrity of the
139+
signature of the Docker image, you can trust the integrity of the
140140
whole supply chain from code source, to CI/CD build, to distribution
141-
on Maven Central or whever you got the jar from.
141+
on Maven Central or whever you got the image from.
142142

143143
You can use the following command to verify the latest image using its
144144
sigstore signature attestation:

0 commit comments

Comments
 (0)