Merge pull request #50 from SpiralOutDotEu/docs/update-with-binary-guide

Docs/update with binary guide

README.md

@@ -14,6 +14,28 @@ To utilize this tool, ensure that the following are installed on your system:
 * [snarkjs](https://github.com/iden3/snarkjs)
 
 ## Recommended Usage
+1) Download, extract and set as executable the binary for your OS from release page: 
+
+   * https://github.com/SpiralOutDotEu/zk_whitelist/releases
+
+2) Create a text file named `addresses.txt` and list the addresses you want to whitelist, one address per line.
+```
+0xdeadbeef...
+0xbadcoffee...
+```
+1) Run the command `zk_whitelist all`. This will generate two Solidity files` verifier.sol` and `zkToken.sol`, alongside a `addresses.txt.proof.json` file.
+```sh
+./zk_whitelist all
+```
+1) Deploy your contracts and use the proofs file from your frontend to call the contract.
+2) Whenever you need to whitelist additional addresses in the future, simply add them to a new file (e.g., `new_addresses.txt`), and run the command `zk_whitelist proofs --input-file "your_new_addresses_file"`. This will generate the necessary proofs for the new addresses and you can use them without any on-chain changes
+```sh
+./zk_whitelist proofs --input-file "your_new_addresses_file"
+```
+
+> Note: Besides `verifier.sol`, `zkToken.sol`, and `..proof.json`, all other generated files should be kept private and secure. Failing to secure these files could allow others to generate proofs on their own.
+
+## Alternative: Build from source
 
 1) clone repo
 ```sh
@@ -44,19 +66,19 @@ cargo run proofs --input-file "your_new_addresses_file"
 ## Commands
 Here are the available commands provided by this tool::
 
-* `cargo run -- help`: show help docs
-* `cargo run circuit`: Creates a circuit file that controls the whitelisting to the current directory.
-* `cargo run compile`: Compiles the circuit file.
-* `cargo run setup`: Executes the setup ceremony to generate a secure setup.
-* `cargo run verifier`: Exports a Solidity verifier.
-* `cargo run movejs`: Moves the contents of circuit_js to the parent directory for convenience reasons.
-* `cargo run token`: Generates a sample token Solidity contract to be used together with the verifier.
-* `cargo run proofs --input-file "<input_file>"`: Generates proofs for a new set of addresses specified in <input_file>. Defaults to `addresses.txt` if no file is specified.
-* `cargo run all --input-file "<input_file>"`: Runs all the commands `(circuit, compile, setup, verifier, movejs, proofs)` one after the other. Defaults to `addresses.txt` if no file is specified.
+* `zk_whitelist --help`: show help docs
+* `zk_whitelist circuit`: Creates a circuit file that controls the whitelisting to the current directory.
+* `zk_whitelist compile`: Compiles the circuit file.
+* `zk_whitelist setup`: Executes the setup ceremony to generate a secure setup.
+* `zk_whitelist verifier`: Exports a Solidity verifier.
+* `zk_whitelist movejs`: Moves the contents of circuit_js to the parent directory for convenience reasons.
+* `zk_whitelist token`: Generates a sample token Solidity contract to be used together with the verifier.
+* `zk_whitelist proofs --input-file "<input_file>"`: Generates proofs for a new set of addresses specified in <input_file>. Defaults to `addresses.txt` if no file is specified.
+* `zk_whitelist all --input-file "<input_file>"`: Runs all the commands `(circuit, compile, setup, verifier, movejs, token, proofs)` one after the other. Defaults to `addresses.txt` if no file is specified.
 
 ## Contributing
 Contributions are welcome! Feel free to submit a Pull Request or open an Issue for any bugs, enhancements, or new features.
 
 
 ---
-*Leverage the power of zero-knowledge proofs to efficiently manage and update your address whitelist while ensuring the privacy and security of your decentralized application.*
+*Leverage the power of zero-knowledge proofs to efficiently manage and update your address whitelist while ensuring the scalability and security of your decentralized application.*

src/cli.rs

@@ -38,7 +38,7 @@ pub enum SubCommand {
     Token,
     /// Generates proofs using an input file, with a default value of "addresses.txt".
     Proofs(ProofsCommand),
-    /// Run all the commands one after the other, {circuit, compile, setup, verifier, movejs, proofs} using an input file, with a default value of "addresses.txt"
+    /// Run all the commands one after the other, {circuit, compile, setup, verifier, movejs, token, proofs} using an input file, with a default value of "addresses.txt"
     All(AllCommand),
 }