# SRX Wiki

Welcome to the **SRX (Secure Random-access Archive Format)** wiki! This is the central documentation hub for SRX, a modern compressed and encrypted archive format designed for performance, security, and extensibility.

---

## 📚 Table of Contents

### Getting Started

- **[Getting Started](Getting-Started)** - Installation, quick start guide, and basic usage
- **[CLI Reference](CLI-Reference)** - Complete command-line interface documentation
- **[Library API](Library-API)** - Using SRX as a Rust library

### Technical Documentation

- **[File Format](File-Format)** - Detailed specification of the SRX archive format
- **[Security](Security)** - Security model, cryptographic choices, and best practices
- **[Performance](Performance)** - Benchmarks, optimization tips, and tuning guide

### Reference

- **[FAQ](FAQ)** - Frequently asked questions
- **[Troubleshooting](Troubleshooting)** - Common issues and solutions
- **[Changelog](Changelog)** - Version history and changes

---

## 🚀 Quick Links

| I want to... | Go to |
|--------------|-------|
| Install SRX | [Getting Started](Getting-Started) |
| Learn CLI commands | [CLI Reference](CLI-Reference) |
| Use SRX in my Rust project | [Library API](Library-API) |
| Understand the file format | [File Format](File-Format) |
| Learn about security | [Security](Security) |
| Optimize performance | [Performance](Performance) |

---

## 🔑 Key Features at a Glance

| Feature | Description |
|---------|-------------|
| **Encryption** | XChaCha20-Poly1305 AEAD cipher |
| **Key Derivation** | Argon2id (resistant to GPU/ASIC attacks) |
| **Compression** | Zstd (default) or LZ4 |
| **Integrity** | BLAKE3 hash |
| **Random Access** | Extract portions without full decompression |
| **Streaming** | Handle files larger than RAM |

---

## 📖 External Resources

- [GitHub Repository](https://github.com/Jamshed-develop/srx)
- [SPEC.md](../SPEC.md) - Formal format specification
- [README.md](../README.md) - Project overview
- [RELEASE_NOTES.md](../RELEASE_NOTES.md) - Release history

---

## 🤝 Contributing

Found a bug or have a suggestion? 

- [Report an Issue](https://github.com/Jamshed-develop/srx/issues)
- [Request a Feature](https://github.com/Jamshed-develop/srx/issues)
- [Submit a Pull Request](https://github.com/Jamshed-develop/srx/pulls)

---

## 📄 License

SRX is licensed under the **GNU General Public License v3.0**. See the [LICENSE](../LICENSE) file for details.

---

*Last updated: February 2026*