Update README to enhance Table of Contents with additional sections and details
This commit is contained in:
parent
8523cb2fb3
commit
69484a8b68
62
README.md
62
README.md
@ -2,6 +2,68 @@
|
||||
|
||||
A distributed peer-to-peer network built with Go and LibP2P, providing decentralized database capabilities with RQLite consensus and replication.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Features](#features)
|
||||
- [System Requirements](#system-requirements)
|
||||
- [Software Dependencies](#software-dependencies)
|
||||
- [Installation](#installation)
|
||||
- [macOS](#macos)
|
||||
- [Ubuntu/Debian](#ubuntudebian)
|
||||
- [Windows](#windows)
|
||||
- [Hardware Requirements](#hardware-requirements)
|
||||
- [Network Ports](#network-ports)
|
||||
- [Quick Start](#quick-start)
|
||||
- [1. Clone and Setup Environment](#1-clone-and-setup-environment)
|
||||
- [2. Generate Bootstrap Identity (Development Only)](#2-generate-bootstrap-identity-development-only)
|
||||
- [3. Build the Project](#3-build-the-project)
|
||||
- [4. Start the Network](#4-start-the-network)
|
||||
- [5. Test with CLI](#5-test-with-cli)
|
||||
- [6. Test Anchat Messaging](#6-test-anchat-messaging)
|
||||
- [Deployment](#deployment)
|
||||
- [Production Installation Script](#production-installation-script)
|
||||
- [One-Command Installation](#one-command-installation)
|
||||
- [What the Script Does](#what-the-script-does)
|
||||
- [Directory Structure](#directory-structure)
|
||||
- [Node Types](#node-types)
|
||||
- [Service Management](#service-management)
|
||||
- [Configuration Files](#configuration-files)
|
||||
- [Security Features](#security-features)
|
||||
- [Network Discovery](#network-discovery)
|
||||
- [Updates and Maintenance](#updates-and-maintenance)
|
||||
- [Monitoring and Troubleshooting](#monitoring-and-troubleshooting)
|
||||
- [Environment Configuration](#environment-configuration)
|
||||
- [Bootstrap Peers Configuration](#bootstrap-peers-configuration)
|
||||
- [Setup for Development](#setup-for-development)
|
||||
- [Configuration Files](#configuration-files-1)
|
||||
- [Multiple Bootstrap Peers](#multiple-bootstrap-peers)
|
||||
- [Checking Configuration](#checking-configuration)
|
||||
- [CLI Commands](#cli-commands)
|
||||
- [Network Operations](#network-operations)
|
||||
- [Storage Operations](#storage-operations)
|
||||
- [Database Operations](#database-operations)
|
||||
- [Pub/Sub Messaging](#pubsub-messaging)
|
||||
- [CLI Options](#cli-options)
|
||||
- [Development](#development)
|
||||
- [Project Structure](#project-structure)
|
||||
- [Building and Testing](#building-and-testing)
|
||||
- [Development Workflow](#development-workflow)
|
||||
- [Environment Setup](#environment-setup)
|
||||
- [Configuration System](#configuration-system)
|
||||
- [Client Library Usage](#client-library-usage)
|
||||
- [Anchat - Decentralized Messaging Application](#anchat---decentralized-messaging-application)
|
||||
- [Features](#features-1)
|
||||
- [Quick Start with Anchat](#quick-start-with-anchat)
|
||||
- [Anchat Commands](#anchat-commands)
|
||||
- [Anchat Configuration](#anchat-configuration)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Common Issues](#common-issues)
|
||||
- [Debug Commands](#debug-commands)
|
||||
- [Environment-specific Issues](#environment-specific-issues)
|
||||
- [Configuration Validation](#configuration-validation)
|
||||
- [Logs and Data](#logs-and-data)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
|
||||
- **Peer-to-Peer Networking**: Built on LibP2P for robust P2P communication
|
||||
|
Loading…
x
Reference in New Issue
Block a user