Skip to content

Commit

Permalink
Describe features in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kijewski committed Sep 16, 2023
1 parent bcbe446 commit a0815ef
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,13 @@ Sign and verify `.zip` and `.tar.gz` files with an ed25519 signing key.
This library contains the brains of [`zipsign`](https://github.com/Kijewski/zipsign).
You can use it in your projects to verify and sign `.zip` and `.tar.gz` files
without running a separate application, e.g. to verify a self-update.

### Features

* `default`: sign and verify `.tar.gz` and `.zip` files
* `sign-tar`: sign a `.tar.gz` file
* `verify-tar`: verify a signed `.tar.gz` file
* `sign-zip`: sign a `.zip` file
* `verify-zip`: verify a signed `.zip` file
* `tar`: combines `sign-tar` and `verify-tar`
* `zip`: combines `sign-zip` and `verify-zip`

0 comments on commit a0815ef

Please sign in to comment.