update the grep commands to work. and update description for each pac…

…kage accordingly.
usherlabs · Dec 24, 2024 · 706f9d6 · 706f9d6
1 parent 347eb2e
commit 706f9d6
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 13 deletions.
diff --git a/docs/generatedocs.sh b/docs/generatedocs.sh
@@ -10,7 +10,6 @@ main() {
         "../rs/verify-remote"
         "../rs/verify-tls"
         "../rs/verity-client"
-        "../examples/zktls"
         "../zk/guest"
         "../zk/host"
     )
@@ -20,15 +19,17 @@ main() {
 
     # The filled template
     package_list_html=''
-    package_version=$(grep -oP '^version\s*=\s*"\K[^"]+' "../Cargo.toml")
+    package_version=$(grep '^version\s*=' "../Cargo.toml" | awk -F '"' '{print $2}')
 
     for current_dir in ${projects_dirs[@]}; do
         # Obtain the Cargo.toml file to the current_directory in the integration
         manifest_path="$current_dir/Cargo.toml"
 
         # Use grep and sed to extract the value of the name, description and version of the package
-        package_name=$(grep -oP '^name\s*=\s*"\K[^"]+' "$manifest_path")
-        package_description=$(grep -oP '^description\s*=\s*"\K[^"]+' "$manifest_path")
+        # package_name=$(grep -oP '^name\s*=\s*"\K[^"]+' "$manifest_path")
+        # package_description=$(grep -oP '^description\s*=\s*"\K[^"]+' "$manifest_path")
+        package_name=$(grep '^name\s*=' "$manifest_path" | awk -F '"' '{print $2}')
+        package_description=$(grep '^description\s*=' "$manifest_path" | awk -F '"' '{print $2}')
 
         package_name_and_version="$package_name-$package_version"
 

diff --git a/docs/templates/base.hbs b/docs/templates/base.hbs
@@ -31,7 +31,7 @@
                 <img src="https://usherlabs.imgix.net/wp-content/uploads/2023/07/Labs-Icon-Concept-2.png?auto=format%2Ccompress&fit=crop&ixlib=php-3.3.0&max-h=800&max-w=800&s=ee768be555714c020bd0a18bffa7dfe3"
                     alt="" srcset="" height="13px">
                 <h2>
-                    Usher Labs
+                    Verity Data Processor (VDP) Framework
                 </h2>
             </div>
         </section>

diff --git a/ic/libraries/Cargo.toml b/ic/libraries/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "verity-ic"
-description = "A library containing utilities for the Verity IC components"
+description = "Utilities for Verity IC (Internet Computer) components, used by Managed Verifier or third-party IC Canisters."
 keywords = ["verity", "IC", "canister"]
 readme = "./README.md"
 version.workspace = true

diff --git a/rs/verify-local/Cargo.toml b/rs/verify-local/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "verity-verify-local"
-description = "A library providing utilities for locally verifying Merkle tree responses obtained from the managed Verity Verifier"
-keywords = ["verity", "IC", "canister", "merkleproof"]
+description = "Utility for locally verifying signed Merkle tree responses obtained from the managed Verity Verifier"
+keywords = ["verity", "IC", "canister", "merkleproof", "ecdsa", "merkle"]
 version.workspace = true
 authors.workspace = true
 homepage.workspace = true

diff --git a/rs/verify-remote/Cargo.toml b/rs/verify-remote/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "verity-verify-remote"
-description = "A library providing utilities for fetching and verifying Merkle tree responses from a managed Verity Verifier in response to proof requests."
-keywords = ["verity", "IC", "canister", "merkleproof", "ecdsa", "merkle"]
+description = "Utility for delegating TLS proof verification to managed Verity Verifier, returning a signed Merkle tree for local/on-chain/in-zkVM verification."
+keywords = ["verity", "IC", "canister", "merkleproof", "ecdsa", "merkle", "tls"]
 version.workspace = true
 authors.workspace = true
 homepage.workspace = true

diff --git a/rs/verify-tls/Cargo.toml b/rs/verify-tls/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "verity-verify-tls"
-description = "Verity Verifier"
+description = "Utility for verifying Verity TLS proofs"
 edition = "2021"
 
 [dependencies]

diff --git a/zk/guest/Cargo.toml b/zk/guest/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "verity-dp-zk-guest"
-description = "A library for utilities regarding the ZK guest"
+description = "Utilities for Verity zkTLS components that reside in the guest/zkVM"
 version.workspace = true
 authors.workspace = true
 homepage.workspace = true

diff --git a/zk/host/Cargo.toml b/zk/host/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "verity-dp-zk-host"
-description = "A library for utilities related to the ZK host"
+description = "Utilities for Verity zkTLS components that reside in the host, orchestrating the zkVM to aggregate TLS proofs."
 version.workspace = true
 authors.workspace = true
 homepage.workspace = true