Skip to content

Commit 723e468

Browse files
committed
Update readme
1 parent 11d943e commit 723e468

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
### git_evtag_py
22

3-
A python script version of [git-evtag](https://github.com/cgwalters/git-evtag/),
3+
A Python implementation of [git-evtag](https://github.com/cgwalters/git-evtag/),
44
inspired by the [upstream Python implementation](https://github.com/cgwalters/git-evtag/blob/7c58b2021a066f1e552deeb37431bc70b6215d62/src/git-evtag-compute-py) but more feature complete and faster.
55

66
This can,
77

8-
- Calculate and show checksum
9-
- Verify checksum of a tag against the one in the tag message
10-
- Sign a tag with the checksum
11-
8+
- Calculate and show the EVTag checksum of tags and commits
9+
- Verify the signature and the EVTag checksum of a tag
10+
- Sign a tag with the EVTag checksum
1211

1312
### Usage
1413

@@ -17,23 +16,23 @@ Install `git`.
1716
Symlink `git-evtag` to `~/.local/bin/git-evtag` or somewhere else that
1817
is in `$PATH`. Then,
1918

20-
```
21-
# Show tree checksum of HEAD
19+
```sh
20+
# Show the EVTag checksum of HEAD
2221
git evtag
2322

24-
# Show tree checksum of tag TAG
23+
# Show the EVTag checksum of the tag 'TAG'
2524
git evtag --rev TAG
2625

27-
# Show tree checksum of commit COMMIT
26+
# Show the EVTag checksum of the commit 'COMMIT'
2827
git evtag --rev COMMIT
2928

30-
# Verify checksum obtained from tag message of tag TAG against the
31-
# one calculated. Also verifies signature of TAG
29+
# Verify the signature and the EVTag checksum obtained from the tag
30+
# message of the tag 'TAG' against the one calculated
3231
git evtag --verify TAG
3332

34-
# Add tree checksum to the tag TAG. Preserves the message of the
35-
# original tag TAG, creates a new tag TAG with the previous message and
36-
# the checksum appended to it
33+
# Add the EVTag checksum to the tag 'TAG'. Preserves the message of the
34+
# original tag 'TAG', creates a new tag 'TAG' with the previous message
35+
# and the EVTag checksum appended to it
3736
git evtag --sign TAG
3837

3938
# Produces 'Git-EVTag-v0-SHA512' prefixed output

0 commit comments

Comments
 (0)