fix: fix publish

witnesscalc_adapter/Cargo.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 description = "Library to run witnesscalc in rust"
 license = "MIT OR Apache-2.0"
-repository = "https://github.com/zkmopro/witnesscalc-adapter"
+repository = "https://github.com/zkmopro/witnesscalc_adapter"
 documentation = "https://zkmopro.org/"
 homepage = "https://zkmopro.org/"
 

witnesscalc_adapter/README.MD

@@ -0,0 +1,61 @@
+# Witnesscalc Adapter
+
+This project provides a Rust adapter for compiling and linking [Circom circuit witness generator C++ sources](https://docs.circom.io/getting-started/computing-the-witness/#computing-the-witness-with-c) into a native library for target platforms (e.g., mobile devices). It includes macros and functions to facilitate the integration of witness generation into Rust codebases.
+
+## Usage
+
+In `build.rs`, add the following code to compile the witness generator C++ sources into a native library and link to it:
+
+```rust
+witnesscalc_adapter::build_and_link("../path to directory containing your C++ sources");
+// e.g. witnesscalc_adapter::build_and_link("../testdata");
+```
+
+In your main code, use the `witness` macro to generate a witness for a given input:
+
+```rust
+witnesscalc_adapter::witness!(<circuit name>);
+// e.g. witnesscalc_adapter::witness!(multiplier2);
+```
+
+Calculate the witness by using the `witnesscalc_<circuit name>` function.
+
+```rust
+let wtns = <circuit name>_witness(inputs_json_string)
+// e.g. let wtns = multiplier2_witness("{\"a\": [\"2\"], \"b\": [\"3\"]}")
+```
+
+It will generate a `wtns` bytes array like the output of [witnesscalc](https://github.com/0xPolygonID/witnesscalc).
+
+Convert the `wtns` to bigints by using the `parse_witness_to_bigints` function.
+
+```rust
+let witness = parse_witness_to_bigints(&wtns).unwrap();
+```
+
+## Supported platforms
+
+### Linux
+
+-   x86_64 linux
+-   arm64 linux
+
+### MacOS
+
+-   aarch64-apple-darwin
+-   x86_64-apple-darwin
+
+### iOS
+
+-   aarch64-apple-ios
+-   aarch64-apple-ios-sim
+-   x86_64-apple-ios
+
+### Android
+
+-   aarch64-linux-android
+-   x86_64-linux-android
+
+# Acknowledgements
+
+Inspired by https://github.com/chancehudson/rust-witness. This adapter relies on the [0xPolygonID/witnesscalc library fork](https://github.com/zkmopro/witnesscalc).