chore: Write agent app README

apps/agent/.env.example

@@ -1,3 +1,5 @@
 PROTOCOL_PROVIDER_PRIVATE_KEY=afdfd9c3d2095ef696594f6cedcae59e72dcd697e2a7521b1578140422a4f890
 BLOCK_NUMBER_BLOCKMETA_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNlIjoidHJ5Iiwibm90aGluZyI6InRvIiwic2VlIjoiaGVyZSJ9.gsWpvMzpzd5_7IN_GU0PhNLH7wuKHl29FHkL5-i18b4
-EBO_AGENT_CONFIG_FILE_PATH="./config.example.yml"
+EBO_AGENT_CONFIG_FILE_PATH="./config.example.yml"
+DISCORD_BOT_TOKEN=YOUR_DISCORD_BOT_TOKEN
+DISCORD_CHANNEL_ID=YOUR_DISCORD_CHANNEL_ID

apps/agent/README.md

@@ -0,0 +1,91 @@
+# Agent Monorepo
+
+The `agent` package is designed as a service that drives the EBO agent's main workflow. It initializes the relevant
+services in the `packages` directory that are necessary to run the agent, like `BlockNumberService` and `ProtocolProvider`.
+The agent interacts with the EBO smart contracts deployed on the chains specified in the `config.yml` file
+that you'll create during this setup process.
+
+## Setup
+
+To set up the EBO agent, follow these steps:
+
+1. **Install Dependencies**: Ensure you have `pnpm` installed, and run:
+
+```bash
+pnpm install
+```
+
+2. **Configure Environment Variables**:
+
+-   Create a `.env` file in the root of the `agent` package. Refer to `.env.example` for the required environment variables.
+-   Populate the file with your environment-specific settings:
+
+```bash
+cp .env.example .env
+```
+
+**Environment Variables**:
+
+| Variable                        | Description                               | Required |
+| ------------------------------- | ----------------------------------------- | -------- |
+| `PROTOCOL_PROVIDER_PRIVATE_KEY` | Private key for the Protocol Provider     | Yes      |
+| `BLOCK_NUMBER_BLOCKMETA_TOKEN`  | BlockmetaBlockNumberService bearer token  | Yes      |
+| `EBO_AGENT_CONFIG_FILE_PATH`    | Path to the agent YAML configuration file | Yes      |
+| `DISCORD_BOT_TOKEN`             | Your Discord bot's token                  | Yes      |
+| `DISCORD_CHANNEL_ID`            | Discord channel ID for notifications      | Yes      |
+
+3. **Configuration File**:
+
+-   The agent also requires a YAML configuration file. The path to this file must be specified in the `.env` file via `EBO_AGENT_CONFIG_FILE_PATH`.
+-   To set up the configuration, copy `config.example.yml` to `config.yml`:
+
+```bash
+cp config.example.yml config.yml
+```
+
+-   Update the `config.yml` file with your specific settings.
+
+## Available Scripts
+
+Here are the scripts you can run using `pnpm`:
+
+| Script        | Description                                    |
+| ------------- | ---------------------------------------------- |
+| `build`       | Build the agent                                |
+| `check-types` | Check for type issues using TypeScript         |
+| `clean`       | Remove `dist` folder                           |
+| `format`      | Check code formatting using Prettier           |
+| `format:fix`  | Automatically fix code formatting issues       |
+| `lint`        | Run ESLint to check for code quality and style |
+| `lint:fix`    | Automatically fix ESLint errors                |
+| `start`       | Start the EBO Agent                            |
+| `test`        | Run tests using Vitest                         |
+| `test:cov`    | Run tests with a coverage report               |
+
+### Running the Agent
+
+To start the EBO Agent, run:
+
+```bash
+pnpm run start
+```
+
+## Running Tests
+
+The `agent` package includes a suite of Vitest and end-to-end (e2e) tests to verify the correct functioning of the agent's processes. To run the Vitest tests, execute:
+
+```bash
+pnpm run test
+```
+
+For a coverage report, run:
+
+```bash
+pnpm run test:cov
+```
+
+### End-to-End Testing
+
+The e2e tests simulate scenarios starting at the contract level and extending to the agent, like processing requests and handling disputes. For detailed test scenarios, refer to the files in `test/e2e/scenarios`.
+
+TODO: Add instructions on running e2e tests

apps/scripts/README.md

@@ -1,6 +1,6 @@
-# EBO Agent Monorepo
+# Scripts Monorepo
 
-This monorepo contains the EBO Agent scripts and packages.
+This monorepo contains scripts relevant to running the EBO agent, such as approving its required modules
 
 ## Setup