Updates README - first draft

README.md

@@ -1,2 +1,114 @@
-# trueblocks-khedra
-A multi-service EVM blockchain index/monitoring tool that indexes, monitors, and shares address appearance indexes.
+# TrueBlocks Khedra
+
+## Intro
+
+`trueblocks-khedra` is an extension (or plugin) to the [TrueBlocks](https://github.com/TrueBlocks/trueblocks-core) system that focuses on providing specialized data extraction, analysis, or other functionality related to Ethereum blockchain indexing. Khedra aims to simplify the process of gathering on-chain data and building advanced, queryable indexes for Ethereum addresses.
+
+Key features:
+
+- **Custom Indexing**: Provides specialized indexing capabilities tailored to specific use-cases beyond the core TrueBlocks functionality.  
+- **Plugin-Based Architecture**: Easily integrates with TrueBlocks while maintaining modular, extensible design.  
+- **Efficient Data Retrieval**: Optimized for quick querying and data lookups, especially when dealing with large Ethereum datasets.
+
+## Installation
+
+1. **Prerequisites**  
+   - Make sure you have [TrueBlocks Core](https://github.com/TrueBlocks/trueblocks-core) installed.  
+   - A C++ build environment (such as `g++` or `clang++`) if you plan to compile from source.  
+   - [CMake](https://cmake.org/) (version 3.16 or higher recommended).  
+   - (Optional) [Docker](https://docs.docker.com/get-docker/) if you plan to run via container.
+
+2. **Clone this Repository**  
+    git clone https://github.com/TrueBlocks/trueblocks-khedra.git  
+    cd trueblocks-khedra  
+
+3. **Build from Source**  
+    mkdir build && cd build  
+    cmake ..  
+    make  
+
+   After a successful build, you’ll find the `khedra` executable (or library, depending on how the project is organized) in the build output.
+
+4. **Install**  
+    sudo make install  
+
+## Configuration
+
+Before using `khedra`, you may need to configure it to point at the TrueBlocks indexing data or specify custom indexing rules:
+
+- **Config File**: By default, `khedra` may look for a configuration file at `~/.trueblocks/trueblocks-khedra.conf`.  
+- **Environment Variables**:  
+  - `KHEDRA_DATA_DIR`: Path to where you want `khedra` to store or read data.  
+  - `KHEDRA_LOG_LEVEL`: Adjusts the verbosity of logs (`DEBUG`, `INFO`, `WARN`, `ERROR`).
+
+Refer to the sample configuration file (`.conf.example`) in this repo for a template of possible settings.
+
+---
+
+## Docker Version
+
+<!--
+  BEGIN SECTION: (Exact text from trueblocks-core README)
+  Copy/Paste the "Docker Version" section here verbatim.
+-->
+
+**(Paste the *exact* Docker Version text from the trueblocks-core README here.)**
+
+---
+
+## Documentation
+
+<!--
+  BEGIN SECTION: (Exact text from trueblocks-core README)
+  Copy/Paste the "Documentation" section here verbatim.
+-->
+
+**(Paste the *exact* Documentation text from the trueblocks-core README here.)**
+
+---
+
+## Linting
+
+<!--
+  BEGIN SECTION: (Exact text from trueblocks-core README)
+  Copy/Paste the "Linting" section here verbatim.
+-->
+
+**(Paste the *exact* Linting text from the trueblocks-core README here.)**
+
+---
+
+## Contributing
+
+<!--
+  BEGIN SECTION: (Exact text from trueblocks-core README)
+  Copy/Paste the "Contributing" section here verbatim.
+-->
+
+**(Paste the *exact* Contributing text from the trueblocks-core README here.)**
+
+---
+
+## Contact
+
+<!--
+  BEGIN SECTION: (Exact text from trueblocks-core README)
+  Copy/Paste the "Contact" section here verbatim.
+-->
+
+**(Paste the *exact* Contact text from the trueblocks-core README here.)**
+
+---
+
+## Contributors
+
+<!--
+  BEGIN SECTION: (Exact text from trueblocks-core README)
+  Copy/Paste the "Contributors" section here verbatim.
+-->
+
+**(Paste the *exact* Contributors text from the trueblocks-core README here.)**
+
+---
+
+_This project is part of the [TrueBlocks](https://github.com/TrueBlocks) ecosystem._