Merge pull request #138 from Merit-Systems/shafu/README

Update README with new contract name and details

Author: shafu0x

README.md

@@ -1,66 +1,36 @@
-# Merit Contracts
+```
+ ███▄ ▄███▓▓█████  ██▀███   ██▓▄▄▄█████▓     ██████▓██   ██▓  ██████ ▄▄▄█████▓▓█████  ███▄ ▄███▓  ██████
+▓██▒▀█▀ ██▒▓█   ▀ ▓██ ▒ ██▒▓██▒▓  ██▒ ▓▒   ▒██    ▒ ▒██  ██▒▒██    ▒ ▓  ██▒ ▓▒▓█   ▀ ▓██▒▀█▀ ██▒▒██    ▒
+▓██    ▓██░▒███   ▓██ ░▄█ ▒▒██▒▒ ▓██░ ▒░   ░ ▓██▄    ▒██ ██░░ ▓██▄   ▒ ▓██░ ▒░▒███   ▓██    ▓██░░ ▓██▄
+▒██    ▒██ ▒▓█  ▄ ▒██▀▀█▄  ░██░░ ▓██▓ ░      ▒   ██▒ ░ ▐██▓░  ▒   ██▒░ ▓██▓ ░ ▒▓█  ▄ ▒██    ▒██   ▒   ██▒
+▒██▒   ░██▒░▒████▒░██▓ ▒██▒░██░  ▒██▒ ░    ▒██████▒▒ ░ ██▒▓░▒██████▒▒  ▒██▒ ░ ░▒████▒▒██▒   ░██▒▒██████▒▒
+░ ▒░   ░  ░░░ ▒░ ░░ ▒▓ ░▒▓░░▓    ▒ ░░      ▒ ▒▓▒ ▒ ░  ██▒▒▒ ▒ ▒▓▒ ▒ ░  ▒ ░░   ░░ ▒░ ░░ ▒░   ░  ░▒ ▒▓▒ ▒ ░
+░  ░      ░ ░ ░  ░  ░▒ ░ ▒░ ▒ ░    ░       ░ ░▒  ░ ░▓██ ░▒░ ░ ░▒  ░ ░    ░     ░ ░  ░░  ░      ░░ ░▒  ░ ░
+░      ░      ░     ░░   ░  ▒ ░  ░         ░  ░  ░  ▒ ▒ ░░  ░  ░  ░    ░         ░   ░      ░   ░  ░  ░
+       ░      ░  ░   ░      ░                    ░  ░ ░           ░              ░  ░       ░         ░
+                                                    ░ ░
+```
 
-We have one contract called [Escrow.sol](./src/Escrow.sol)
+# Merit Escrow
 
-| Single Operation | Batch Operation | Description                                     |
-| ---------------- | --------------- | ----------------------------------------------- |
-| `deposit`        | `batchDeposit`  | Deposit tokens into escrow                      |
-| `claim`          | `batchClaim`    | Claim tokens as the recipient                   |
-| `reclaim`        | `batchReclaim`  | Reclaim tokens as the sender after claim period |
+Escrow contract for secure token distributions with signature-based claims.
 
-### Build
+## Core Contract
 
-`forge build`
+[`Escrow.sol`](src/Escrow.sol) - The main escrow contract supporting both repository-managed and direct distributions.
 
-### Test
+## Building
 
-`forge test`
+```bash
+forge build
+```
 
-### Deploy
+## Testing
 
-##### Sepolia
+```bash
+forge test
+```
 
-`make deploy-sepolia`
+## Audits
 
-##### Base Sepolia
-
-`make deploy-base-sepolia`
-
-##### Base
-
-`make deploy-base`
-
-### Audits
-
-All reports are in [audits](./audits/)
-
-### Create2Crunch Vanity Address Mining
-
-The project includes a vanity address miner using [create2crunch](https://github.com/0age/create2crunch) to find specific contract addresses that match desired patterns. This is particularly useful for creating contracts at predictable addresses.
-
-To use create2crunch:
-
-1. Navigate to the create2crunch directory:
-
-   ```bash
-   cd create2crunch
-   ```
-
-2. Configure the parameters in `run.sh`:
-
-   - `OWNER`: Contract owner address
-   - `SIGNER`: Signer address
-   - `TOKENS`: Array of token addresses
-   - `FEE_BPS`: Fee basis points
-   - `BATCH_LIMIT`: Batch size limit
-   - `FACTORY`: Factory contract address
-   - `CALLER`: Caller address
-
-3. Run the mining script:
-   ```bash
-   ./run.sh
-   ```
-
-The script will compile the contract, generate the initialization code, and use create2crunch to find salt values that generate contract addresses matching your desired patterns.
-
-For more detailed information, see the [create2crunch README](./create2crunch/README.md).
+Multiple security audits have been conducted. See the [audits directory](audits/) for all audit reports.