diff --git a/README.md b/README.md index 7eec55c..f216364 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,29 @@
a rich text editor by canvas
+a rich text editor by canvas/svg
## 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 + +``` +```javascript +import Editor from "@hufe921/canvas-editor" + +new Editor(document.querySelector(".canvas-editor"), [ + { + value: "Hello World" + } + ]) +``` ## snapshot