Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DPende committed Apr 21, 2024
1 parent 1625748 commit ea0821a
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,66 @@ A powerful and versatile image editing library for the browser.
Adjust brightness, contrast, saturation, and other image parameters.
Apply filters and effects for creative transformations.

## Installation

### Using in the browser
#### Install with npm

``` bash
npm i editpix
```
In your html file:

```html
<script type="module" src="example.js"></script>
```
In your javascript file
```javascript
import EditPix from './node_modules/editpix/src/editpix.js';

const editpix = new Editpix();

// use library
```

#### Load from CDN.

In your html file:

```html
<script type="module" src="example.js"></script>
```

In your javascript file
```javascript
import EditPix from 'https://cdn.jsdelivr.net/npm/editpix/+esm';

const editpix = new Editpix();

// use library
```

### Using in Vue.js

#### Install with npm
```bash
npm i editpix
```

#### Import in your component
```javascript
<script setup>

import EditPix from "editpix"

const editpix = new EditPix()

//use library

</script>
```


## Features

- edit directly within the browser, without the need for Node
Expand Down

0 comments on commit ea0821a

Please sign in to comment.