Readme Updated (#193)

* chore: readme udpated:

* chore: readme updated

* chore(readme): re-added a few sections that were missed earlier

* chore(readme): linting

* chore: linting and formatting

* chore: linting and formatting

* chore: linting and formatting

* chore: script added for dummy contract deployment, readme udpated to use dummy sharp service

* update: aws_event_bridge rework

* update: e2e

* chore: linting-formatting and readme updated

* chore: readme misinformation fixed

* update: verification job timeout and polling changed to work for 25 hours

* chore: comment added for older python version needed

* refactor: event bridge type added

* chore: linting and formatting of toml files

* update: time delay for txn finality in state update increased to 30 mins

---------

Co-authored-by: mohiiit <mohit18343@iiitd.ac.in>
Co-authored-by: Heemank Verma <heemankv@gmail.com>

.env.example

@@ -8,6 +8,7 @@ AWS_ENDPOINT_URL=                    # AWS endpoint URL
 AWS_DEFAULT_REGION=                  # AWS default region
 
 # For EventBridge
+MADARA_ORCHESTRATOR_EVENT_BRIDGE_TYPE=       # EventBridge type (rule/schedule)
 MADARA_ORCHESTRATOR_EVENT_BRIDGE_TRIGGER_RULE_NAME=       # EventBridge rule name
 MADARA_ORCHESTRATOR_EVENT_BRIDGE_TRIGGER_ROLE_NAME=       # EventBridge role name
 MADARA_ORCHESTRATOR_EVENT_BRIDGE_TRIGGER_POLICY_NAME=     # EventBridge policy name

.env.test

@@ -10,7 +10,7 @@ AWS_ENDPOINT_URL=http://localhost.localstack.cloud:4566
 AWS_DEFAULT_REGION=localhost
 
 # For EventBridge
-
+MADARA_ORCHESTRATOR_EVENT_BRIDGE_TYPE=rule
 MADARA_ORCHESTRATOR_EVENT_BRIDGE_TRIGGER_RULE_NAME=madara-orchestrator-worker-trigger
 MADARA_ORCHESTRATOR_EVENT_BRIDGE_TRIGGER_ROLE_NAME=madara-orchestrator-worker-trigger-role
 MADARA_ORCHESTRATOR_EVENT_BRIDGE_TRIGGER_POLICY_NAME=madara-orchestrator-worker-trigger-policy

.markdownlint.json

@@ -4,6 +4,7 @@
   "MD045": false,
   "MD003": false,
   "MD013": {
-    "code_blocks": false
+    "code_blocks": false,
+    "line_length": 120
   }
 }

.prettierignore

@@ -7,3 +7,4 @@ pathfinder/
 orchestrator_venv/
 build/
 node_modules/
+scripts/

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## Added
 
+- readme: setup instructions added
 - Added : Grafana dashboard
 - tests: http_client tests added
 - Added Atlantic proving service integration