@hufe921/canvas-editor 0.9.9

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-present, hufe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+<h1 align="center">canvas-editor</h1>
+
+<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)
+
+## 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
+
+![image](https://github.com/Hufe921/canvas-editor/blob/main/src/assets/snapshots/main_v0.9.8.png)
+
+## next features
+
+1. optimize content block
+2. control rules
+3. table paging
+4. docs
+
+## install
+
+`yarn`
+
+## dev
+
+`yarn run dev`
+
+## build
+
+#### app
+`yarn run build`
+
+#### lib
+`yarn run lib`