From 0a0b3c73a31f1fb5ea980baa89c6e6ef18761911 Mon Sep 17 00:00:00 2001 From: DPende Date: Sat, 27 Apr 2024 14:35:25 +0200 Subject: [PATCH] refactor: add docs link --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2468eb5..628d631 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ ![Image](/assets/editpix-logo.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![NPM Test on Main](https://github.com/studio-YOLO/editpix/actions/workflows/main.yml/badge.svg)](https://github.com/studio-YOLO/editpix/actions/workflows/main.yml) -[![npm](https://img.shields.io/npm/dm/editpix.svg)](https://www.npmjs.com/package/editpix) -[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/editpix/badge)](https://www.jsdelivr.com/package/npm/editpix) +[![Test on Main](https://github.com/studio-YOLO/editpix/actions/workflows/main.yml/badge.svg)](https://github.com/studio-YOLO/editpix/actions/workflows/main.yml) +[![npm](https://img.shields.io/npm/dm/editpix?logo=npm)](https://www.npmjs.com/package/editpix) +[![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/editpix?logo=jsdeliver)](https://www.jsdelivr.com/package/npm/editpix) A powerful and versatile image editing library for the browser. @@ -19,6 +19,9 @@ A complete list of the available features is available [below](#Features). --- +## Documentation +Please follow the documentation at the [following link](https://studio-yolo.github.io/editpix-doc/). + ## Installation EditPix supports multiple different installation methods. @@ -113,7 +116,6 @@ If it is useful to you, at the [following link](https://github.com/studio-YOLO/e - RGB (to and from HSL, HEX) - HSL (to and from RGB) - HEX (to and from RGB) - - Higher contrast - Color filters: - Black and white - Grayscale @@ -153,8 +155,6 @@ If it is useful to you, at the [following link](https://github.com/studio-YOLO/e Here's a short tutorial / example on loading an image, performing simple edits, and then saving. ```jsx -import EditPix from "./src/editpix.js"; - const editpix = new EditPix(); // image url