From 851f98cc4ba822d3161d46357be9b05e2241eebb Mon Sep 17 00:00:00 2001
From: 0xyaco <yaco@defi.sucks>
Date: Thu, 18 Jul 2024 16:06:01 -0300
Subject: [PATCH] docs: Add basic README.md (#6)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

# 🤖 Linear

Closes GRT-35

## Description
Adds a basic README file.
---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 91467e7..53c828c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,57 @@
-# ebo-agent
\ No newline at end of file
+# ebo-agent
+
+The Epoch Block Oracle (EBO) introduces the use of an optimistic oracle ([Prophet](https://docs.prophet.tech/)), enabling any off-chain agent to interact with it by creating requests, proposing responses, or disputing responses in a permissionless manner. This document outlines a comprehensive implementation strategy for the agent responsible for automating all workflows associated with EBO. Within this document, you will find a detailed presentation of the high-level architecture, code design, process flows, technology stack, and project estimations.
+
+## Table of contents
+
+* Background
+* Install
+* Usage
+* Contributing
+
+## Background
+
+The EBO agent is an open-source tool designed to poll events from the relevant on-chain smart contracts on the Protocol chain (Arbitrum) and respond to these events with specific actions tailored to the flow requirements. Additionally, the agent will interface with blockchains supported by The Graph and perform block computations for each epoch as necessary. These computations are required for various scenarios, such as responding to a request, validating a proposal, and revalidating a proposal during a dispute.
+
+
+```mermaid
+flowchart LR;
+    A[EBO Agent] --> B[Arbitrum RPC];
+    B --> Oracle & EBORequestCreator & DataEdge;
+    subgraph block-beta:Chains [Indexed Chains]
+      C[Chain 1]
+      D[Chain ...]
+      E[Chain N]
+    end
+    subgraph block-beta:RPC [Data Providers]
+      F[RPC Nodes]
+      H[Substreams]
+    end
+    A --> block-beta:RPC
+    block-beta:RPC --> block-beta:Chains
+```
+
+## Install
+```
+$ pnpm install
+```
+
+## Usage
+
+```
+$ pnpm start
+```
+
+## Test
+
+```
+$ pnpm test
+```
+
+## Contributing
+
+Prophet was built with ❤️ by [Wonderland](https://defi.sucks).
+
+Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.
+
+[DeFi sucks](https://defi.sucks), but Wonderland is here to make it better.
\ No newline at end of file