Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hufe921 committed Sep 27, 2023
1 parent 33ebc59 commit 5ad1414
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
<h1 align="center">canvas-editor</h1>

<p align="center">
<a href="https://www.npmjs.com/package/@hufe921/canvas-editor"><img src="https://img.shields.io/npm/v/@hufe921/canvas-editor.svg?sanitize=true" alt="Version"></a>
<a href="https://www.npmjs.com/package/@hufe921/canvas-editor"><img src="https://img.shields.io/npm/l/@hufe921/canvas-editor.svg?sanitize=true" alt="License"></a>
<a href="https://github.com/Hufe921/canvas-editor/issues/new/choose"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs"></a>
</p>

<p align="center"> a rich text editor by canvas/svg</p>

## tips
Expand All @@ -14,24 +20,28 @@
```bash
npm i @hufe921/canvas-editor --save
```

```html
<div class="canvas-editor"></div>
```

```javascript
import Editor from "@hufe921/canvas-editor"
import Editor from '@hufe921/canvas-editor'

new Editor(document.querySelector(".canvas-editor"), [
new Editor(document.querySelector('.canvas-editor'), {
main: [
{
value: "Hello World"
value: 'Hello World'
}
])
]
})
```

## next features

1. improve performance
2. control rules
3. table paging
1. table paging
2. improve performance
3. control rules
4. [CRDT](https://github.com/Hufe921/canvas-editor/tree/feature/CRDT)

## snapshot
Expand All @@ -49,7 +59,9 @@ new Editor(document.querySelector(".canvas-editor"), [
## build

#### app

`npm run build`

#### lib
`npm run lib`

`npm run lib`

0 comments on commit 5ad1414

Please sign in to comment.