From d83f60cf87845f9bf049572d0166bf4a86fc1468 Mon Sep 17 00:00:00 2001 From: Mohammad Javad Ebrahimi Date: Thu, 8 Feb 2024 14:09:43 +0330 Subject: [PATCH] Update README.md --- README.md | 6 ++---- src/EasyCaching.Extensions.EasyCompressor/README.md | 9 +++++++-- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 04f79b6..304c75e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ # EasyCompressor - 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**. + 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. @@ -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 :
- Brotli *(**Highest** compression ratio - the **Smallest** size) (**Only** available in .NETCoreApp2.1, .NETStandard2.1 and above)*
- GZip
- Deflate
- ZLib *(**Only** available in .NET6.0 and above)* @@ -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 @@ -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). diff --git a/src/EasyCaching.Extensions.EasyCompressor/README.md b/src/EasyCaching.Extensions.EasyCompressor/README.md index b7a10d7..c121445 100644 --- a/src/EasyCaching.Extensions.EasyCompressor/README.md +++ b/src/EasyCaching.Extensions.EasyCompressor/README.md @@ -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 @@ -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).