From fd5cce666c720bb1d96b382f7d19b49433c21abc Mon Sep 17 00:00:00 2001
From: Szekely-Schnedarek Marton <43480627+Smorci@users.noreply.github.com>
Date: Fri, 6 Sep 2024 08:43:10 +0200
Subject: [PATCH] Update README.md

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 18483e1..58d3305 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,19 @@
 # ethereum-node-automation
-Automated solution to setup a local network of at least three ethereum nodes
+Simple to use, packaged, continuously deployed solution to start 3 monitored ethereum nodes in your local environment
+
+## Pre-requisite
+1.Nix version 2.18.2 or higher. Follow the [installation instructions](https://nix.dev/install-nix.html) for your operating system.
+2. Github personal access token. Follow the [official documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) or take a look at the detailed application specific documentation in this repository.
+
+## `.env` file
+
+Create a `.env` file in the repository root, adding your github access token
+```
+export GITHUB_TOKEN=<your-github-access-token>
+```
+> Replace `<your-github-access-token>` with the generated access token in *pre-requisite* section
+
+## Usage
 
 ```
 kind create cluster --name ethereum-nodes