Publishing Package changes (#44)

* needed description

* adding verifier description

* removing path

* removing the include cause both include and exclude can't be present. Causing package publishing problems.

* fixing path

* fixing readme

primitives/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "rust-kzg-bn254-primitives"
 version = "0.1.0"
+description = "This library offers a set of structs, traits and functions for generating Blobs and Polynomials which are used to interact with rust-kzg-bn254-prover and rust-kzg-bn254-verifier crates."
 edition.workspace = true
 repository.workspace = true
 license-file.workspace = true

primitives/README.md

@@ -1,6 +1,6 @@
 # rust-kzg-bn254-primitives
 
-[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254.svg)](https://crates.io/crates/rust-kzg-bn254-primitives)
+[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254-primitives.svg)](https://crates.io/crates/rust-kzg-bn254-primitives)
 
 This library offers primitive set of structures and functions for generating and interacting with bn254 KZG commitments and proofs in rust.
 

prover/Cargo.toml

@@ -8,11 +8,9 @@ readme = "README.md"
 repository.workspace = true
 license-file.workspace = true
 exclude = ["tests/*", "benches/*"]
-# TODO: is this needed for the image to show up in the rust docs?
-include = ["./kzg_commitment_diagram.png"]
 
 [dependencies]
-rust-kzg-bn254-primitives = { path = "../primitives", version = "0.1.0" }
+rust-kzg-bn254-primitives = { version = "0.1.0" }
 ark-bn254 = "0.5.0"
 ark-ec = { version = "0.5.0", features = ["parallel"] }
 ark-ff = { version = "0.5.0", features = ["parallel"] }

prover/README.md

@@ -1,7 +1,7 @@
 # rust-kzg-bn254
 
-[![Docs](https://docs.rs/rust-kzg-bn254/badge.svg)](https://docs.rs/rust-kzg-bn254/latest/rust_kzg_bn254/)
-[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254.svg)](https://crates.io/crates/rust-kzg-bn254)
+[![Docs](https://docs.rs/rust-kzg-bn254-prover/badge.svg)](https://docs.rs/rust-kzg-bn254-prover/latest/rust_kzg_bn254_prover/)
+[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254-prover.svg)](https://crates.io/crates/rust-kzg-bn254-prover)
 
 This library offers a set of functions for generating and interacting with bn254 KZG commitments and proofs in rust, with the motivation of supporting fraud and validity proof logic in EigenDA rollup integrations.
 
@@ -15,7 +15,7 @@ This library offers a set of functions for generating and interacting with bn254
 
 See the `test_compute_kzg_proof` function in [./tests/kzg_test.rs](./tests/kzg_test.rs) for an end to end usage of the library.
 
-Also make sure to check out the examples in our [docs](https://docs.rs/rust-kzg-bn254/latest/rust_kzg_bn254/).
+Also make sure to check out the examples in our [docs](https://docs.rs/rust-kzg-bn254-prover/latest/rust_kzg_bn254_prover/).
 
 ## Setup for testing
 

verifier/Cargo.toml

@@ -1,13 +1,14 @@
 [package]
 name = "rust-kzg-bn254-verifier"
 version = "0.1.0"
+description = "This library offers a set of functions for verifying KZG commitments and proofs in bn254, with the motivation of supporting fraud and validity proof logic in EigenDA rollup integrations."
 license-file.workspace = true
 edition.workspace = true
 rust-version.workspace = true
 repository.workspace = true
 
 [dependencies]
-rust-kzg-bn254-primitives = { path = "../primitives", version = "0.1.0" }
+rust-kzg-bn254-primitives = { version = "0.1.0" }
 ark-bn254 = "0.5.0"
 ark-ec = { version = "0.5.0", features = ["parallel"] }
 ark-ff = { version = "0.5.0", features = ["parallel"] }
@@ -18,7 +19,7 @@ rand = "0.8.5"
 criterion = "0.5"
 lazy_static = "1.5"
 ark-std = { version = "0.5.0", features = ["parallel"] }
-rust-kzg-bn254-prover = { path = "../prover", version = "0.1.0" }
+rust-kzg-bn254-prover = { version = "0.1.0" }
 
 [[bench]]
 name = "bench_kzg_verify"

verifier/README.md

@@ -1,8 +1,8 @@
-# rust-kzg-bn254-batch-verification
+# rust-kzg-bn254-verification
 
-[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254.svg)](https://crates.io/crates/rust-kzg-bn254-batch-verification)
+[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254-verifier.svg)](https://crates.io/crates/rust-kzg-bn254-verifier)
 
-This library offers batch verification functions for KZG.
+This library offers verification functions, including batch verification, for KZG.
 
 ## Warning & Disclaimer