Update README

Kijewski · Sep 14, 2023 · a33721b · a33721b
1 parent a10d3f8
commit a33721b
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 26 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,10 +1,11 @@
 [package]
 name = "zipsign"
-description = "Sign a file with an ed25519 signing key"
+description = "Sign and verify `.zip` and `.tar.gz` files with an ed25519 signing key"
 version = "0.1.0-a.0"
 edition = "2021"
 authors = ["René Kijewski <[email protected]>"]
-license = "MIT OR Apache-2.0 WITH LLVM-exception"
+repository = "https://github.com/Kijewski/zipsign"
+license = "Apache-2.0 WITH LLVM-exception"
 
 [workspace]
 resolver = "2"

diff --git a/LICENSE.mit b/LICENSE.mit
diff --git a/README.md b/README.md
@@ -1,4 +1,10 @@
-## zipsign: Sign a file with an ed25519ph signing key
+## zipsign
+
+A tool to sign and verify `.zip` and `.tar.gz` files with an ed25519 signing key.
+
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Kijewski/zipsign/ci.yml?branch=main)](https://github.com/Kijewski/zipsign/actions/workflows/ci.yml)
+[![Crates.io](https://img.shields.io/crates/v/zipsign?logo=rust)](https://crates.io/crates/zipsign-api)
+![License: License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-informational?logo=apache)
 
 ### Install
 

diff --git a/api/Cargo.toml b/api/Cargo.toml
@@ -1,10 +1,11 @@
 [package]
 name = "zipsign-api"
-description = "Verify files signed with `zipsign`"
+description = "Sign and verify `.zip` and `.tar.gz` files with an ed25519 signing key"
 version = "0.1.0-a.0"
 edition = "2021"
 authors = ["René Kijewski <[email protected]>"]
-license = "MIT OR Apache-2.0 WITH LLVM-exception"
+repository = "https://github.com/Kijewski/zipsign"
+license = "Apache-2.0 WITH LLVM-exception"
 
 [dependencies]
 base64 = { workspace = true, optional = true }

diff --git a/api/LICENSE.mit b/api/LICENSE.mit
diff --git a/api/README.md b/api/README.md
@@ -1 +1,11 @@
-## zipsign-api: Verify ed25519ph signed files
+## zipsign-api
+
+Sign and verify `.zip` and `.tar.gz` files with an ed25519 signing key.
+
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Kijewski/zipsign/ci.yml?branch=main)](https://github.com/Kijewski/zipsign/actions/workflows/ci.yml)
+[![Crates.io](https://img.shields.io/crates/v/zipsign?logo=rust)](https://crates.io/crates/zipsign)
+![License: License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-informational?logo=apache)
+
+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.