Technical documentation and protocol overview for Swafe.
This documentation provides a comprehensive overview of the Swafe protocol, covering its design principles, cryptographic foundations, and implementation details. It serves as both a technical specification and practical guide for understanding how Swafe enables secure sharing and access control.
This project uses mdBook to generate the documentation. The book includes mathematical notation rendered using KaTeX.
- mdBook
- mdbook-katex preprocessor for mathematical notation
# Install mdBook
cargo install mdbook
# Install KaTeX preprocessor
cargo install mdbook-katexTo build and serve the book locally:
# Build the book
mdbook build
# Serve the book locally (with auto-reload)
mdbook serveThe book will be available at http://localhost:3000 by default.