From 75a95d936112d81d283cb789194189487f57d3d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Kijewski?= Date: Sat, 16 Sep 2023 17:02:20 +0200 Subject: [PATCH] Describe features in README --- api/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/api/README.md b/api/README.md index 9a758af..65eafb6 100644 --- a/api/README.md +++ b/api/README.md @@ -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-zip`: sign a `.zip` file +* `verify-zip`: verify a signed `.zip` file +* `sign-tar`: sign a `.tar.gz` file +* `verify-tar`: verify a signed `.tar.gz` file +* `tar`: combines `sign-tar` and `verify-tar` +* `zip`: combines `sign-zip` and `verify-zip`