From 6f1bc532bf0ad68239281dc5a530a9092b554595 Mon Sep 17 00:00:00 2001
From: Andrew <www.andru90@gmail.com>
Date: Thu, 30 Mar 2023 00:11:32 +0300
Subject: [PATCH] Create README.md

---
 README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..93b2fb6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+
+
+# SimpleImageCompressor
+
+[![Software License][ico-license]](LICENSE.md) 
+
+**SimpleImageCompressor** - is a tiny simple PHP image compressor lib which allows you to compress any image easily on the fly.
+
+## Installation
+
+ 1.  Download latest release [here](https://github.com/Geckon01/simple-image-compressor/releases).
+ 2. Unpack archive to any folder of your project you wish.
+ 3. Load main lib files:
+
+```php
+require "src/SimpleImageCompressor.php";  
+require "src/CompressedImage.php";
+use geckon01\SimpleImageCompressor\SimpleImageCompressor;
+```
+
+## Usage
+
+To resize and compress your image you can use next code:
+```php
+$resulutionTargetPercent = 50;
+$targetQuality = 50;
+$compressor = SimpleImageCompressor::load("image.png");
+$compressedImage = $compressor->resizeAndCompress($resulutionTargetPercent, $targetQuality);
+$compressedImage->toFile("image");
+```
+load method supports loading from local file, or you can specify any valid URL image link like this:
+```php
+$compressor = SimpleImageCompressor::load("https://example.com/image.jpg");
+```
+This lib support chaining, so you can do something like this:
+```php
+SimpleImageCompressor::load("image.png")
+	->resizeAndCompress(50, 50)
+	->toFile("image");
+```
+> Note that you don't need to specify file extension. The lib will save
+> file with proper one automatically. 
+
+### Output format
+You can specify output format. Supported output fomats are:
+
+```php 
+$compressedImage->toFile("image");
+```
+```php 
+$compressedImage->toBase64();
+```
+```php 
+$compressedImage->toGdImage();
+```
+### Max/min height/width
+Also you can set approximate minumum and maximum image size. 
+```php 
+$compressor->setApproxMinimumHeight(500);  
+$compressor->setApproxMinimumWidth(500);
+```
+> Note that Due to saving proportion lib can't guarantee that width and height be equals max and min . 
+As example, if we have original image 1920x1080 which we want to get 50% of original resolution  and save original 16x9 aspect ration the reduced image must be 960x540.
+
+## License
+
+This software is licensed under the MIT License. [View the license](LICENSE.md).
+
+[ico-license]: https://img.shields.io/badge/license-MIT-green