From 7e8e67d4e9c1692e5b91ccb28614b1d9c3f62163 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=BB=84=E4=BA=91=E9=A3=9E?= <huangyunfeihufe@hotmail.com>
Date: Thu, 8 Dec 2022 17:47:41 +0800
Subject: [PATCH] docs:npm package usage

---
 README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7eec55c..f216364 100644
--- a/README.md
+++ b/README.md
@@ -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