Skip to content

Commit

Permalink
docs: update readme with key features
Browse files Browse the repository at this point in the history
  • Loading branch information
robertrosman committed May 22, 2024
1 parent 07b86ab commit af50fea
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@

vue-paint is a simple and lightweight paint component for vue projects. It can be used to add annotations to images, videos, or just draw some simple shapes to a canvas-like area.

Demo: [https://github.com/robertrosman/vue-paint]

## Key features

### Tree shakable

Only include the tools you need and leave the rest outside of your bundle.

### Non-destructive

Support for both undo and redo, even after result is exported.

### Clean format

The state is a simple javascript array of objects you can serialize to JSON, manipulate programmatically, store in your database or local storage.

### Easily extendable

Create your own tools if you want to extend the library.

### Type safe

Written in Typescript and fully typed.


## Project Setup

Expand All @@ -26,3 +50,7 @@ npm run build
```sh
npm run lint
```

## Contribute

Contributions are welcome! Fork and create a new Pull request. Try to follow the patterns in `src/composables/tools` when creating new tools.

0 comments on commit af50fea

Please sign in to comment.