From 3b00d73491da548133ae7642a05122d6b6475476 Mon Sep 17 00:00:00 2001
From: Miguel Filipe <miguel.filipe@gmail.com>
Date: Mon, 17 Jun 2024 16:57:18 +0100
Subject: [PATCH] Update README with more details

---
 Makefile  |  2 +-
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 52 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index 213f564..00b99d4 100644
--- a/Makefile
+++ b/Makefile
@@ -18,7 +18,7 @@ bin/golangci-lint:
 bin/gofumpt: bin
 	GOBIN=$(PWD)/bin go install mvdan.cc/gofumpt@v0.6.0
 
-build: lint cmd/main.go
+build: cmd/main.go
 	go build -o indexer cmd/main.go
 
 lint: bin/golangci-lint bin/gofumpt
diff --git a/README.md b/README.md
index 066b0b8..c971f7c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,51 @@
-# blockchain-ingester
-A simple program that ingests blockchain data into Dune
+# blockchain node indexer
+A program that indexes blockchain data into HTTPS://DUNE.COM by connecting directly to an RPC node
+
+# Limitations
+
+This program works with EVM compatible blockchains, doing direct, EVM-specific JSON-RPC calls to the Node RPC endpoint.
+
+
+# How to use:
+
+There are only 3 required arguments for running the indexer:
+  1. DUNE_API_KEY: Your Dune API Key, you can get this at: https://dune.com/settings/api
+  1. BLOCKCHAIN_NAME: The name of the blockchain as configured on Dune (for example: "ethereum" blockchain)
+  1. RPC_NODE_URL: The URL of the NODE RPC endpoint, for example: https://sepolia.optimism.io/
+
+For more details see the configuration options section
+
+
+## Docker Container
+
+You can use our public docker container image and run it as such:
+
+```bash
+docker run -e BLOCKCHAIN_NAME='foo' -e RPC_NODE_URL='http://localhost:8545' -e DUNE_API_KEY='your-key-here' duneanalytics/node-indexer
+
+```
+BLOCKCHAIN_NAME='foo' RPC_NODE_URL='https://localhost:8545' DUNE_API_KEY='your-key-here' ./indexer
+
+
+
+## Binary executable
+
+You can also just build and run a binary executable after cloning this repository:
+
+Build the binary for your OS:
+```bash
+$ make build
+
+$ BLOCKCHAIN_NAME='foo' RPC_NODE_URL='http://localhost:8545' DUNE_API_KEY='your-key-here' ./indexer
+
+```
+
+## Configuration Options
+
+You can see all the configuration options by using the `--help` argument:
+```bash
+docker run duneanalytics/node-indexer ./indexer --help
+
+```
+
+