Updated README.md #118
Updated README.md #118
Conversation
kairveeehh
force-pushed
the
master
branch
4 times, most recently
from
c4b7b71 to
5834e50
Compare
|
@nirs kindly review and merge. |
README.md
Outdated
| curl -OSL "https://github.com/lima-vm/socket_vmnet/releases/download/${VERSION}/${FILE}" | ||
| ``` |
There was a problem hiding this comment.
I think we can improve the user experience a little bit by merging the getting the latest version and download steps to one script. We can add a sentence after the example explaining the details.
Download the latest release binary:
VERSION="$(curl -fsSL https://api.github.com/repos/lima-vm/socket_vmnet/releases/latest | jq -r .tag_name)"
FILE="socket_vmnet-${VERSION:1}-$(uname -m).tar.gz"
curl -OSL "https://github.com/lima-vm/socket_vmnet/releases/download/${VERSION}/${FILE}"This gets the latest release version using github api and download the binary.
But let's wait for @jandubois review, he was concerned about removing the comments.
README.md
Outdated
| gh attestation verify --owner=lima-vm "${FILE}" | ||
| ``` |
There was a problem hiding this comment.
The problem with this part is that most people will skip this part since this is optional. I think we want to help people to start using attestations.
Also the text is not helpful because most user do not know that is "GitHub Artifact Attestation". We should replace this with a short sentence using term that most users already know, and link to relevant docs adding more info.
We can use an alert like this:
Tip
To verify the downloaded binary using GitHub's gh command (https://cli.github.com), run:
gh attestation verify --owner=lima-vm "${FILE}"Learn more about GitHub Artifact Attestation
README.md
Outdated
| tar tzvf "${FILE}" | ||
| ``` |
There was a problem hiding this comment.
I think this we can drop this part. tar is well known and we don't need to explain that you can view the binary using it.
But let's wait for @AkihiroSuda ack on this.
|
alright awaiting both of their response on it. will do the fixes accordingly. |
|
@kairveeehh closed by mistake? |
Yes actually this was causing trouble over the other PR I had to raise so closed this , and will reopen this one. |
solves (#96 )
Updated the readme to have separate copyable commands.