docs: add README

Author: HrikB

README.md

@@ -1,66 +1,42 @@
-## Foundry
+# OpenVM Solidity SDK
 
-**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+This repo houses OpenVM verifier contracts generated on official release commits of the [openvm](https://github.com/openvm-org/openvm) repo with the default VM config using the `cargo-openvm` cli tool. Advanced VM configurations may require their own generations.
 
-Foundry consists of:
+## Installation
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+To install `openvm-solidity-sdk` as a dependency in your forge project, run the following:
 
-## Documentation
-
-https://book.getfoundry.sh/
-
-## Usage
-
-### Build
-
-```shell
-$ forge build
-```
-
-### Test
-
-```shell
-$ forge test
+```bash
+forge install openvm-org/openvm-solidity-sdk
 ```
 
-### Format
+## Usage
 
-```shell
-$ forge fmt
-```
+If you are using a deployed instance of the verifier contract, then you can import the interfaces in your contract directly.
 
-### Gas Snapshots
+```solidity
+import { IOpenVmHalo2Verifier } from "openvm-solidity-sdk/v1.1.1/interfaces/IOpenVmHalo2Verifier.sol";
 
-```shell
-$ forge snapshot
-```
+contract MyContract {
+    function myFunction() public view {
+        // ... snip ...
 
-### Anvil
+        IOpenVmHalo2Verifier(verifierAddress)
+            .verify(publicValues, proofData, appExeCommit, appVmCommit);
 
-```shell
-$ anvil
+        // ... snip ...
+    }
+}
 ```
 
-### Deploy
+If you want to deploy your own instance of the verifier contract, you can use `forge create`:
 
-```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
+```bash
+forge create src/v1.1.1/OpenVmHalo2Verifier.sol:OpenVmHalo2Verifier --rpc-url $RPC --private-key $PRIVATE_KEY --broadcast
 ```
 
-### Cast
+If you want to import the verifier into your own repo for testing purposes, it might be a bit trickier. The verifier contracts are locked to version `0.8.19` of solc, so if you are using a different version, the import will not be compilable. If you are using a different version, as a workaround, you can compile the contract and `vm.etch()` the raw bytecode into your tests.
 
-```shell
-$ cast <subcommand>
-```
-
-### Help
+## Audits
 
-```shell
-$ forge --help
-$ anvil --help
-$ cast --help
-```
+You can find the audit reports for these contracts in the [OpenVM repo](https://github.com/openvm-org/openvm/tree/main/audits).