Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AbsoluteZero000 authored Oct 9, 2024
1 parent 42d26cf commit fdf65e0
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
**Crunch: Your Data Compression Powerhouse**
# **Crunch: Your Data Compression Powerhouse**

**Introduction**
![demo](./demo.gif "demo")

## **Introduction**

Crunch is a robust command-line tool written in Go that empowers you to achieve efficient data compression using the venerable Huffman coding algorithm. It streamlines the process, making it a breeze to compress your files while maintaining clarity and control.

**Features**
## **Features**

- **Lossless Compression:** Crunch preserves the integrity of your data, ensuring an exact reconstruction upon decompression.
- **Customizable Verbosity:** Control the level of detail displayed during compression with the `-v` flag, allowing you to tailor the output to your preferences.
- **Streamlined File Handling:** Crunch seamlessly handles both input and output files, making compression workflows effortless.

**How to Build**
## **How to Build**
```bash
go build -o crunch .
```

**Usage**
## **Usage**

1. **Encode Data:**
```bash
Expand All @@ -35,19 +37,19 @@ Crunch is a robust command-line tool written in Go that empowers you to achieve
```
This example compresses `sample_data.txt` while providing informative progress messages about the compression process.

**Contributing**
## **Contributing**

We welcome contributions to Crunch! Feel free to fork the repository on GitHub (link coming soon) and submit pull requests for bug fixes, enhancements, or documentation improvements.

**License**
## **License**

Crunch is distributed under the MIT License (see LICENSE file).

**Disclaimer**
## **Disclaimer**

While Crunch offers effective compression, some file types might not experience significant size reduction due to inherent redundancies within the data itself.

**Future Enhancements**
## **Future Enhancements**

- Support for multiple compression algorithms (e.g., LZMA)
- Integration with popular archive management tools
Expand Down

0 comments on commit fdf65e0

Please sign in to comment.