Skip to content

Commit

Permalink
docs: try fixing links
Browse files Browse the repository at this point in the history
  • Loading branch information
tbraun96 committed Nov 25, 2024
1 parent 88b47f8 commit 086fa8d
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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/))
Expand Down

0 comments on commit 086fa8d

Please sign in to comment.