mirror of
https://github.com/rustfs/rustfs.git
synced 2026-01-17 01:30:33 +00:00
3dbcaaa221
* docs: simplify all crates README files - Remove extensive code examples and detailed documentation - Convert to minimal module introductions with core feature lists - Direct users to main RustFS repository for comprehensive docs - Updated 20 crate README files for consistency and brevity Files updated: - crates/rio/README.md (415→15 lines) - crates/s3select-api/README.md (592→15 lines) - crates/s3select-query/README.md (658→15 lines) - crates/signer/README.md (407→15 lines) - crates/utils/README.md (395→15 lines) - crates/workers/README.md (463→15 lines) - crates/zip/README.md (408→15 lines) * docs: restore original headers in crates README files - Add back RustFS logo image and CI badges - Restore formatted headers and structured layout - Keep simplified content with module introductions - Maintain consistent documentation structure across all crates All 20 crate README files now have proper headers while keeping the simplified content that directs users to the main repository. * rules: enforce PR-only workflow for main branch - Strengthen rule that ALL changes must go through pull requests - Explicitly forbid direct commits to main branch under any circumstances - Add comprehensive PR requirements and enforcement guidelines - Clarify that PRs are the ONLY way to merge to main branch - Add requirement for PR approval before merging - Include enforcement mechanisms for branch protection
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
[](https://rustfs.com)
|
|
|
|
# RustFS Zip - Compression & Archiving
|
|
|
|
<p align="center">
|
|
<strong>High-performance compression and archiving for RustFS object storage</strong>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/rustfs/rustfs/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/rustfs/rustfs/actions/workflows/ci.yml/badge.svg" /></a>
|
|
<a href="https://docs.rustfs.com/en/">📖 Documentation</a>
|
|
· <a href="https://github.com/rustfs/rustfs/issues">🐛 Bug Reports</a>
|
|
· <a href="https://github.com/rustfs/rustfs/discussions">💬 Discussions</a>
|
|
</p>
|
|
|
|
---
|
|
|
|
## 📖 Overview
|
|
|
|
**RustFS Zip** provides high-performance compression and archiving capabilities for the [RustFS](https://rustfs.com) distributed object storage system. For the complete RustFS experience, please visit the [main RustFS repository](https://github.com/rustfs/rustfs).
|
|
|
|
## ✨ Features
|
|
|
|
- Multiple compression algorithms (Zstd, LZ4, Gzip, Brotli)
|
|
- Streaming compression for memory efficiency
|
|
- Parallel processing for large files
|
|
- Archive format support (ZIP, TAR, custom formats)
|
|
- Adaptive compression with content-type detection
|
|
- Compression analytics and performance metrics
|
|
|
|
## 📚 Documentation
|
|
|
|
For comprehensive documentation, examples, and usage guides, please visit the main [RustFS repository](https://github.com/rustfs/rustfs).
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the Apache License 2.0 - see the [LICENSE](../../LICENSE) file for details.
|