cat > README.md << 'EOF'
quicburn
A blazing fast QUIC implementation in Rust
About
quicburn is a modern, high-performance QUIC protocol implementation built in Rust. It leverages quinn and provides a clean, workspace-based architecture for building QUIC-enabled applications.
Whether you're building a client, server, or both, quicburn provides the foundation you need.
✨ Features
- High-performance - Built on
quinnandrustls - Secure by default - Modern TLS 1.3 with Rustls
- Workspace architecture - Clean separation of concerns
- Modular crates - Use what you need:
quicburn-client- Client-side QUIC implementationquicburn-server- Server-side QUIC implementationquicburn-shared- Shared utilities and typesquicburn-macros- Shared macros
- Comprehensive tests - Unit and integration tests
- Developer friendly - Justfile for common tasks
Quick Start
# Clone the repository
# Build everything
# Run tests
# Run an example
Using Just
# List all available tasks
# Build the workspace
# Run tests
# Run all pre-push checks
# Format code
# Run clippy
# Generate documentation
# Clean build artifacts
# Update dependencies
# Security audit
Publishing
# 1. Check everything compiles
# 2. Run tests
# 3. Run clippy
# 4. Check formatting
# 5. Run security audit
# 6. Check license compliance
# 7. Check documentation builds
# 8. Verify package contents
# 9. Check for dependency issues
# Or use just to run all checks