Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 1.69 KB

README.md

File metadata and controls

57 lines (43 loc) · 1.69 KB

Text Compressor (TC)

Text Compressor (TC) is a Rust library designed for efficient text compression using Huffman encoding, a widely used lossless data compression algorithm. This library aims to provide developers with a lightweight, easy-to-integrate solution for compressing and decompressing textual data.

Features

  • Huffman Encoding: Compress text data using the well-known Huffman algorithm.
  • Lossless Compression: Ensures that the original data can be perfectly reconstructed after decompression.
  • Lightweight and Fast: Designed to minimize overhead and maximize performance.
  • Flexible API: Provides easy-to-use functions for compressing and decompressing strings.

Installation

Add tc to your Cargo.toml:

[dependencies]
tc = { git = "https://github.com/root-hunter/tc.git" }

Then, include it in your code:

use tc::core::{compress, decompress}

Usage

Contribution

Contributions, bug reports, and feature requests are welcome! Feel free to open an issue or a pull request on the GitHub repository.

Development Setup

  1. Clone the repository:
git clone https://github.com/root-hunter/tc.git
  1. Build the project:
cargo build
  1. Run tests:
cargo test

Roadmap

  • Multi-Thread Compression/Decompression
  • Size optimization

License

This project is licensed under the MIT License.

Feel free to use, modify, and distribute the library under the terms of the license.

Happy compressing! 🎉