Update README.md

Author: victormimo

README.md

@@ -1,14 +1,70 @@
-<div align="center">
-  <a href="https://github.com/victormimo/open-captable-protocol/blob/main/LICENSE">
-    <img alt="License" src="https://img.shields.io/github/license/victormimo/open-captable-protocol">
-  </a>
-</div>
+# Open Cap Table Protocol (OCP)
 
-# Documentation
+This repository implements the **Open Cap Table Protocol (OCP)** for managing cap tables on-chain. It adheres to the **Open Cap Format (OCF)** standard for data modeling and validation. OCP supports managing cap tables across multiple **EVM-compatible chains**.
 
-This repo is based on the [Open Cap Table Coalition](https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF) standard, with the license included in its entirety.
+## Repo Organization
+- **`src/`** → Server files (routes, MongoDB, etc.)
+- **`chain/`** → Smart contracts (Diamond pattern with facets)
 
-## License
+## Prerequisites
+Ensure you have the following installed:
+- [Forge](https://book.getfoundry.sh/)
+- [Node.js](https://nodejs.org/)
+- [Yarn](https://yarnpkg.com/)
+
+## Setup & Running Locally
+1. Copy `.env.example` to `.env`. (The example file includes a local database setup for testing, which we recommend.)
+2. Start dependencies:
+   - **Terminal 1:** Start Anvil
+     ```sh
+     anvil
+     ```
+   - **Terminal 2:** Run the backend server
+     ```sh
+     yarn dev
+     ```
+   - **Terminal 3:** Deploy contracts locally
+     ```sh
+     yarn deploy:local
+     ```
+3. You should see the factory contracts successfully deployed.
+
+## Multi-Chain Support
+This repository supports deploying cap tables to different **EVM chains**.
+- Check `/src/chain.js` and configure the required chain keys.
+- When making API requests:
+  - **Issuer creation** → Pass `chainId` in the request body.
+  - **Other transactions** (e.g., creating stakeholders, issuing stock) → Pass `issuerId` in the request body.
+- See `/src/routes` for implementation details.
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+## Usage
+1. Create an **issuer** first.
+2. Add **stakeholders**, stock classes, and other relevant data.
+3. For quick testing, use the example script:
+   ```sh
+   node src/examples/testTransfer.mjs
+   ```
 
+## Resetting Local Testing
+If you are frequently testing locally, reset the database before redeploying:
+```sh
+yarn deseed
+```
+
+## Deployment
+Use the appropriate command to deploy contracts:
+- **Local:**
+  ```sh
+  yarn deploy:local
+  ```
+- **Testnet:**
+  ```sh
+  yarn deploy:testnet
+  ```
+- **Mainnet:**
+  ```sh
+  yarn deploy:mainnet
+  ```
+
+## License
+This project is licensed under the MIT License. See the [`LICENSE`](LICENSE) file for details.