docs:npm package usage

2022-12-08 17:47:41 +08:00
parent e69dcd3ca3
commit 7e8e67d4e9
1 changed files with 19 additions and 2 deletions
@@ -1,12 +1,29 @@
 <h1 align="center">canvas-editor</h1>

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

 ## tips

 1. The render layer by svg is under development, see [feature/svg](https://github.com/Hufe921/canvas-editor/tree/feature/svg)
 2. The export pdf feature is available now, see [feature/pdf](https://github.com/Hufe921/canvas-editor/tree/feature/pdf)
-3. The official NPM package will be available after the release of version 1.0.0
+
+## usage
+
+```bash
+npm i @hufe921/canvas-editor --save
+```
+```html
+<div class="canvas-editor"></div>
+```
+```javascript
+import Editor from "@hufe921/canvas-editor"
+
+new Editor(document.querySelector(".canvas-editor"), [
+    {
+      value: "Hello World"
+    }
+  ])
+```

 ## snapshot