diff --git a/README.md b/README.md index c2d51a433..2712b445f 100644 --- a/README.md +++ b/README.md @@ -22,28 +22,28 @@ A post-quantum secure networking protocol that makes developing hyper-secure client-server and P2P applications easy. Built with 100% safe Rust, it provides a robust foundation for creating secure, high-performance network applications with built-in NAT traversal and post-quantum cryptography using a very low memory footprint. ## ๐Ÿ“‘ Table of Contents -- [๐ŸŒŸ Key Features](#key-features) -- [๐Ÿš€ Quick Start](#quick-start) -- [๐Ÿ”’ Security Architecture](#security-architecture) -- [๐Ÿ“‚ Remote Encrypted Virtual Filesystem](#remote-encrypted-virtual-filesystem) -- [โšก Threading Modes](#threading-modes) -- [๐Ÿ’พ Backend Storage](#backend-storage) -- [๐Ÿ“š Documentation](#documentation) -- [๐Ÿ“œ Patent and Open Source](#patent-and-open-source-commitment) -- [๐Ÿงช Testing](#testing) -- [๐Ÿ›ก๏ธ Security Considerations](#security-considerations) -- [๐Ÿค Contributing](#contributing) -- [โš–๏ธ License](#license) -- [๐Ÿ“ž Contact](#contact) -- [๐ŸŽฏ Examples](#examples) +- [๐ŸŒŸ Key Features](#-key-features) +- [๐Ÿš€ Quick Start](#-quick-start) +- [๐Ÿ”’ Security Architecture](#-security-architecture) +- [๐Ÿ“‚ Remote Encrypted Virtual Filesystem](#-remote-encrypted-virtual-filesystem) +- [โšก Threading Modes](#-threading-modes) +- [๐Ÿ’พ Backend Storage](#-backend-storage) +- [๐Ÿ“š Documentation](#-documentation) +- [๐Ÿ“œ Patent and Open Source](#-patent-and-open-source-commitment) +- [๐Ÿงช Testing](#-testing) +- [๐Ÿ›ก๏ธ Security Considerations](#๏ธ-security-considerations) +- [๐Ÿค Contributing](#-contributing) +- [โš–๏ธ License](#๏ธ-license) +- [๐Ÿ“ž Contact](#-contact) +- [๐ŸŽฏ Examples](#-examples) ## ๐ŸŒŸ Key Features -- ๐Ÿ”’ [Advanced Post-Quantum Security](#advanced-post-quantum-security) - Novel multi-layered ratcheting algorithm -- ๐Ÿ›ก๏ธ [Customizable Security Modes](#customizable-security-modes) - Balance between security and performance -- ๐Ÿ“‚ [Remote Encrypted Virtual Filesystem](#remote-encrypted-virtual-filesystem) - Secure remote storage solution -- โšก [Flexible Threading Modes](#threading-modes) - Single and multi-threaded operation -- ๐Ÿ’พ [Multiple Backend Options](#backend-storage-options) - Various storage solutions +- ๐Ÿ”’ [Advanced Post-Quantum Security](#-advanced-post-quantum-security) - Novel multi-layered ratcheting algorithm +- ๐Ÿ›ก๏ธ [Customizable Security Modes](#๏ธ-security-modes) - Balance between security and performance +- ๐Ÿ“‚ [Remote Encrypted Virtual Filesystem](#-remote-encrypted-virtual-filesystem) - Secure remote storage solution +- โšก [Flexible Threading Modes](#-threading-modes) - Single and multi-threaded operation +- ๐Ÿ’พ [Multiple Backend Options](#-backend-storage) - Various storage solutions - ๐ŸŒ Built-in NAT Traversal - No port forwarding required - ๐Ÿ“ฑ Cross-Platform Support - Run anywhere - ๐Ÿš€ High Performance - Low latency, minimal resource usage @@ -56,7 +56,7 @@ Multiple Key Encapsulation Mechanism (KEM) families: - [NTRU](https://ntru.org/) (Sntrup761) Novel Multi-layered Security Architecture: -- [Patent-pending](#patent-and-open-source-commitment) multi-layered ratcheting algorithm +- [Patent-pending](#-patent-and-open-source-commitment) multi-layered ratcheting algorithm - Per-message re-keying mechanism - Multi-layered key exchange protocol - Multi-layered encryption with customizable algorithms @@ -65,13 +65,13 @@ Novel Multi-layered Security Architecture: - ChaCha20-Poly1305 - [Ascon-80pq](https://ascon.iaik.tugraz.at/) - Novel Kyber "scramcryption" for enhanced security -- [Customizable Security Modes](#security-modes): +- [Customizable Security Modes](#๏ธ-security-modes): - *True* Perfect Forward Secrecy (PFS) mode with advanced ratcheting - Best-effort Mode (BEM) for high-throughput scenarios - Configurable security levels and algorithm combinations ## ๐ŸŒ Flexible Network Architecture -- [Client-Server and P2P support](#quick-start) +- [Client-Server and P2P support](#-quick-start) - Built-in NAT traversal with STUN/TURN capabilities - Multiple transport protocols: - TCP @@ -80,11 +80,11 @@ Novel Multi-layered Security Architecture: - [WebRTC](https://webrtc.org/) compatibility (optional feature) ## โšก Advanced Features -- [Remote Encrypted Virtual Filesystem (RE-VFS)](#remote-encrypted-virtual-filesystem) -- [Device-dependent and credential-based authentication](#security-architecture) +- [Remote Encrypted Virtual Filesystem (RE-VFS)](#-remote-encrypted-virtual-filesystem) +- [Device-dependent and credential-based authentication](#-security-architecture) - Automatic peer discovery -## ๐Ÿ’พ [Backend Storage Options](#backend-storage) +## ๐Ÿ’พ [Backend Storage Options](#-backend-storage) - Local filesystem (default) - [Redis](https://redis.io/) support - SQL support ([MySQL](https://www.mysql.com/), [PostgreSQL](https://www.postgresql.org/), [SQLite](https://www.sqlite.org/))