Skip to content

Commit

Permalink
refactor: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DPende committed Apr 24, 2024
1 parent eb4e549 commit 0c6fb87
Showing 1 changed file with 34 additions and 33 deletions.
67 changes: 34 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,12 @@ A complete list of the available features is available [below](#Features).

EditPix supports multiple different installation methods.


### Usage in the browser
For use in the browser the library can be installed via [npm](#installing-from-npm) or loaded via [CDN](#loading-from-a-cdn).


#### Installing from `npm`
### Installing from `npm`

```bash
npm i editpix
Expand All @@ -46,9 +49,6 @@ const editpix = new Editpix();

// use library
```
<br />


### Loading from a CDN

In your HTML file, load the script as a module:
Expand All @@ -74,16 +74,17 @@ You can also choose the version of the library you prefer by specifying it in th
import EditPix from 'https://cdn.jsdelivr.net/npm/editpix@[version]/+esm';
```

<br>

### Usage in Vue.js

#### Installing from `npm`
Installing from `npm`

```bash
npm i editpix
```

### Import and use in your component
Import and use in your component:

```jsx
<script setup>
Expand All @@ -104,38 +105,38 @@ If it is useful to you, at the [following link](https://github.com/studio-YOLO/e

## Features

- edit directly within the browser, without the need for Node
- easy to use functions, that do exactly what you'd expect from them
- 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:
- Colorspace transforms:
- RGB (to and from HSL, HEX)
- HSL (to and from RGB)
- HEX (to and from RGB)
- higher contrast
- color filters:
- black and white
- grayscale
- sepia
- color adjustments:
- saturation
- temperature
- tint
- image resizing:
- by target width
- by target height
- by percentage
- value adjustments:
- brightness
- contrast
- exposure
- opacity
- shadows
- highlights
- sharpness
- other tools:
- extract color palette
- extract dominant color
- Higher contrast
- Color filters:
- Black and white
- Grayscale
- Sepia
- Color adjustments:
- Saturation
- Temperature
- Tint
- Image resizing:
- By target width
- By target height
- By percentage
- Value adjustments:
- Brightness
- Contrast
- Exposure
- Opacity
- Shadows
- Highlights
- Sharpness
- Other tools:
- Extract color palette
- Extract dominant color

## Project structure
+ `demo/` - a collection of demo scripts of all features.
Expand Down

0 comments on commit 0c6fb87

Please sign in to comment.