From c8f2c7353239ed718c33c3134fbe4a6e963397da Mon Sep 17 00:00:00 2001
From: Anders Konring <anders.konring@gmail.com>
Date: Wed, 17 Jul 2024 11:19:34 +0200
Subject: [PATCH] new readme. (#11)

initial readme file.
---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 87faf3578f..cea1f48f0c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,32 @@
-# Polygon CDK Validium Node
-
+# Espresso Fork of Polygon CDK Validium Node
+Home of a special fork of Polygon CDK Validium Node working on the following modifications:
+1. Integrate Espresso Tiramisu as DA layer.
+2. Replace zkevm-prover with a special [SP1-based prover](https://github.com/EspressoSystems/zkrollup-integration/) supporting namespace proofs.
+
+## Getting Started
+To enter the development shell: `nix develop`
+
+Original Polygon CDK Validium Node docs below.
+
+## Polygon CDK Validium Node
+### Table of Contents
+[Run a CDK Validium](#run-a-cdk-validium)  
+    [Development](#development)  
+[Key Components](#key-components)  
+    [Aggregator](#aggregator)  
+    [Prover](#prover)   
+    [Sequencer](#sequencer)   
+    [SequenceSender](#sequencesender)   
+    [Synchronizer](#synchronizer)   
+    [Data Availability Configuration](#data-availability-configuration)   
+    [Executor](#executor)  
+    [EthTxManager](#ethtxmanager)  
+    [State](#state)  
+    [Pool](#pool)  
+    [JSON RPC](#json-rpc)  
+    [L2GasPricer](#l2gaspricer)  
+
+---
 For a full overview of the CDK-Validium please reference the [CDK documentation](https://wiki.polygon.technology/docs/cdk/).
 
 The CDK-Validium solution is made up of several components, start with the [CDK Validium Node](https://github.com/0xPolygon/cdk-validium-node). However, for quick reference, the complete list of components are outlined below: