Update documentation and add new guides

This commit updates multiple documentation files to improve clarity, remove emojis, and add new sections. Key changes include the addition of 'development.md' and 'performance.md', updates to the quickstart guide, and enhancements to the API and CLI documentation. These changes aim to provide better guidance for users and contributors.
This commit is contained in:
xixu-me committed 2025-06-06 22:00:11 +08:00
1 parent 42180498e0
commit 44843e0035
8 files changed
+916 -137

No files matched your search

+6 -6
View File
@@ -25,17 +25,17 @@ The command-line interface module provides comprehensive functionality for the t
The tzst CLI provides a powerful command-line interface for archive operations with intuitive commands and comprehensive options. The interface is designed for both interactive use and scripting, with robust error handling and user-friendly output.
### 🔧 Core Commands
### Core Commands
| Command | Aliases | Description | Streaming Support |
|---------|---------|-------------|-------------------|
| `a` | `add`, `create` | Create or add to archive | N/A |
| `x` | `extract` | Extract with full paths | ✓ `--streaming` |
| `e` | `extract-flat` | Extract without directory structure | ✓ `--streaming` |
| `l` | `list` | List archive contents | ✓ `--streaming` |
| `t` | `test` | Test archive integrity | ✓ `--streaming` |
| `x` | `extract` | Extract with full paths | `--streaming` |
| `e` | `extract-flat` | Extract without directory structure | `--streaming` |
| `l` | `list` | List archive contents | `--streaming` |
| `t` | `test` | Test archive integrity | `--streaming` |
### 🎯 Key Features
### Key Features
- **Intuitive Commands**: Simple, memorable command aliases (a, x, e, l, t)
- **Streaming Support**: Memory-efficient processing for large archives
+4 -4
View File
@@ -104,26 +104,26 @@ Exception hierarchy for comprehensive error handling and debugging support.
## Key Features
### 🛡️ Security First
### Security First
- Built-in path traversal protection
- Multiple security filter options
- Safe extraction by default
### ⚡ High Performance
### High Performance
- Zstandard compression with configurable levels
- Streaming support for large archives
- Memory-efficient operations
### 🔧 Developer Friendly
### Developer Friendly
- Clean, Pythonic API
- Comprehensive error handling
- Context manager support
- Extensive documentation and examples
### 🌐 Cross-Platform
### Cross-Platform
- Works on Windows, macOS, and Linux
- Consistent behavior across platforms