diff --git a/README.md b/README.md index d88fc08..c82da7b 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,20 @@ This repository includes: - **Install & Management Scripts** – Scripts for streamlined installation and maintenance. +- [Capital Index Database Middleware](#capital-index-database-middleware) + - [Overview](#overview) + - [About This Project](#about-this-project) + - [Repository Contents](#repository-contents) + - [Getting Started](#getting-started) + - [Installation](#installation) + - [Step 1: Install Required Dependencies](#step-1-install-required-dependencies) + - [Step 2: Run the Setup Script](#step-2-run-the-setup-script) + - [Configuration](#configuration) + - [1. API\_PORT](#1-api_port) + - [2. CONTAINER\_NAME](#2-container_name) + - [3. HAS\_LOCAL\_DBS](#3-has_local_dbs) + - [Test your setup:](#test-your-setup) + ## Getting Started