Skip to content

swafe-io/swafe-book

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Swafe Zero

Technical documentation and protocol overview for Swafe.

About

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.

Building the Book

This project uses mdBook to generate the documentation. The book includes mathematical notation rendered using KaTeX.

Prerequisites

Installation

# Install mdBook
cargo install mdbook

# Install KaTeX preprocessor
cargo install mdbook-katex

Building

To build and serve the book locally:

# Build the book
mdbook build

# Serve the book locally (with auto-reload)
mdbook serve

The book will be available at http://localhost:3000 by default.

About

Swafe Book: Cryptographic Design

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors