From b035ac36ee9319a143334dcbd0a876c2c19f30ea Mon Sep 17 00:00:00 2001
From: povilaszvaliauskas <povilas.zva@gmail.com>
Date: Tue, 9 Jul 2024 10:18:46 +0300
Subject: [PATCH] define required variables in readme

---
 README.md | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 04162cb..7360956 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,35 @@ Getting usage help.
 ./build/dydx-publisher --help
 ```
 
-Running executable with flags.
+## Required variables:
+To enable the publishing features, you must set the following environment variables before starting the `dydx` publisher. These variables configure the NATS connection and define the publishing settings:
+
+- **NATS URL**  
+  `NATS_URL=nats://dal-broker`
+
+- **NATS NKey**  
+  `NATS_NKEY=SA..BC`
+
+- **NATS JWT**  
+  `NATS_JWT=eyJ0e...aW`
+
+- **Publisher Prefix**
+  `PUB_PREFIX=my-org`
+
+- **Publisher Name**
+  `PUB_NAME=dydx`
+
+- **Application API Endpoint**
+  `APP_API=http://localhost:1317`
+
+- **gRPC API Endpoint**
+  `GRPC_API=localhost:9090`
+
+- **Tendermint API Endpoint**
+  `TENDERMINT_API=tcp://localhost:26657`
+
+
+ Running executable with flags.
 
 ```bash
 ./build/dydx-publisher \
@@ -35,7 +63,7 @@ Running executable with flags.
   --publisher-name dydx
 ```
 
-Running executable with environment variables. Environment variables are automatically attempted to be loaded from `.env` file.
+ Running executable with environment variables. Environment variables are automatically attempted to be loaded from `.env` file.
 Any flag can be used as environment variables by updating flag to be `UPPERCASE` words separated by `_` (e.g.: flag `nats-nkey` == env var `NATS_NKEY`).
 
 ```bash