Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mjebrahimi committed Feb 8, 2024
1 parent eca9d3d commit d83f60c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# EasyCompressor

<img src="src/EasyCompressor.png" width="100" height="100" align="left"/> An **Easy-to-Use** and **Optimized** compression library for .NET that unified several compression algorithms including **LZ4**, **Snappy**, **Zstd**, **LZMA**, **Brotli**, **GZip**, **ZLib**, and **Deflate**.
<img src="src/EasyCompressor.png" width="100" height="100" align="left"/> An **Easy-to-Use** and **Optimized** compression library for .NET that unified several compression algorithms including **LZ4**, **Snappy**, **Zstd**, **LZMA**, **Brotli**, **GZip**, **ZLib**, and **Deflate**.

Along with a great [**Performance Benchmark**](#benchmarks) between different compression algorithms.

Expand Down Expand Up @@ -40,7 +40,6 @@ It's important to note that the actual time savings will depend on various facto

## Nuget Packages


| Package | Description
| ------------ | ----------------------
| [EasyCompressor](https://www.nuget.org/packages/EasyCompressor/) | Including Algorithms :<br/>- Brotli *(**Highest** compression ratio - the **Smallest** size) (**Only** available in .NETCoreApp2.1, .NETStandard2.1 and above)*<br/>- GZip<br/>- Deflate<br/>- ZLib *(**Only** available in .NET6.0 and above)*
Expand All @@ -57,7 +56,6 @@ It's important to note that the actual time savings will depend on various facto

All of these packages are **cross-platform** except `EasyCompressor.Zstd` and `EasyCompressor.Snappy` which are **not cross-platform** because their underlying library are just a wrapper around the native dlls only for windows.


## Get Started

### 1. Install Package
Expand Down Expand Up @@ -334,4 +332,4 @@ If you find this repository useful and like it, why not give it a star? if not,

## License

Copyright © 2020 [Mohammd Javad Ebrahimi](https://github.com/mjebrahimi) under the [MIT License](https://github.com/mjebrahimi/EasyCompressor/LICENSE).
Copyright © 2020 [Mohammad Javad Ebrahimi](https://github.com/mjebrahimi) under the [MIT License](https://github.com/mjebrahimi/EasyCompressor/LICENSE).
9 changes: 7 additions & 2 deletions src/EasyCaching.Extensions.EasyCompressor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,16 @@ This library aids in **Improving Performance** by **Reducing Memory Usage** and

### 1. Install Package

```ini
```bash
PM> Install-Package EasyCaching.Extensions.EasyCompressor
PM> Install-Package EasyCompressor.LZ4

PM> # Install-Package EasyCompressor.Snappier
PM> # Install-Package EasyCompressor.ZstdSharp
PM> # Install-Package EasyCompressor (for Brotli, GZip, Deflate, ZLib)
```


### 2. Add Services


Expand Down Expand Up @@ -93,4 +98,4 @@ If you find this repository useful and like it, why not give it a star? if not,

## License

Copyright © 2020 [Mohammd Javad Ebrahimi](https://github.com/mjebrahimi) under the [MIT License](https://github.com/mjebrahimi/EasyCompressor/LICENSE).
Copyright © 2020 [Mohammad Javad Ebrahimi](https://github.com/mjebrahimi) under the [MIT License](https://github.com/mjebrahimi/EasyCompressor/LICENSE).

0 comments on commit d83f60c

Please sign in to comment.