From 5517d3d2ebd84880702fde32bbe638cf9ff041a2 Mon Sep 17 00:00:00 2001
From: DPende <pendesini.daniele@gmail.com>
Date: Sat, 20 Apr 2024 22:07:11 +0200
Subject: [PATCH] update readme

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 36 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 0be2b63..7d1950b 100644
--- a/README.md
+++ b/README.md
@@ -4,23 +4,22 @@
 
 A powerful and versatile image editing library for the browser.
 
-![key1](Assets/logo.png)
-
-## Basic Editing:
+## Basic Editing
 
 Adjust brightness, contrast, saturation, and other image parameters.
 Apply filters and effects for creative transformations.
 
-## Features:
+## Features
 
-- edit directly within the browser, without the need for node
+- edit directly within the browser, without the need for Node
 - easy to use functions that do exactly what you'd expect from them
 
 **Currently implemented features:**
 - colorspace transforms:
     - RGB
     - HSL
-    - Hex
+    - HEX
+    - higher contrast
 - color filters:
     - black and white
     - grayscale
@@ -29,41 +28,54 @@ Apply filters and effects for creative transformations.
     - saturation
     - temperature
     - tint
+- image resizing
 - value adjustments:
     - brightness
     - contrast
     - exposure
     - opacity
+    - shadows
+    - highlights
+    - sharpness
 - other tools:
     - extract color palette
+    - extract dominant color
 
+## Project structure
++ `demo/` - collection of demo scripts of all features.
++ `lib/` - rust code for functions in wasm.
++ `src/core/` - all the functions for image editing.
++ `src/editpix.js` - main class of the library where all the functionality is grouped.
++ `src/image-manager.js` - image-related functions such as resizing or image-to-pixelArray conversion.
++ `src/utils.js` - utility functions shared between features.
++ `test/` - Node unit tests using Jest.
 
-### Supported Formats:
-
-Handles common image formats (JPEG, PNG, GIF, etc.)
 
-### Basic Usage:
+## Basic Usage
 
 Short tutorial on loading an image, performing simple edits, and saving.
 Examples:
 
 ```javascript
-import EditPix from "../../src/editpix.js";
+import EditPix from "./src/editpix.js";
 
 const editpix = new EditPix();
 
-const url = "images/img1.jpg";
+// image url
+const url = "images/img.jpg";
 
+// create image
 var image = new Image();
 image.src = url;
 
-//waiting image load
+// waiting image load
 image.onload = () => {
-
     // convert image to gray scale
     editpix.toGrayScale(image)
         .then(grayScaledImage => {
+            // render original image
             document.body.appendChild(image);
+            // render modified image
             document.body.appendChild(grayScaledImage);
         })
         .catch(error => { console.log(error) })
@@ -72,8 +84,16 @@ image.onload = () => {
 
 ## Contributing
 
-We welcome contributions! Please follow our Code of Conduct.
+We welcome contributions! Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Contributors
+[![Contributors](https://contrib.rocks/image?repo=studio-YOLO/editpix)](https://github.com/studio-YOLO/editpix/graphs/contributors)
+
+## Authors
+- [DPende](https://github.com/DPende)
+- [VinciGit00](https://github.com/VinciGit00)
+- [f-aguzzi](https://github.com/f-aguzzi)
 
 ## License
 
-This library is provided under the MIT license.
\ No newline at end of file
+This library is provided under the [MIT license](LICENSE).
\ No newline at end of file