From 38fc481208bafec8e72400c433563891e9e2a8b4 Mon Sep 17 00:00:00 2001
From: chenshenhai <cshenhai@gmail.com>
Date: Mon, 29 Nov 2021 22:16:05 +0800
Subject: [PATCH] docs: update readme for @idraw/renderer

---
 packages/renderer/README.md | 67 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 66 insertions(+), 1 deletion(-)

diff --git a/packages/renderer/README.md b/packages/renderer/README.md
index 6582554..2f1cfac 100644
--- a/packages/renderer/README.md
+++ b/packages/renderer/README.md
@@ -1,3 +1,68 @@
 # @idraw/renderer
 
-[![Node.js CI](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml)
\ No newline at end of file
+[![Node.js CI](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml)
+
+
+## Usage
+
+### Quick Start
+
+```sh
+npm i @idraw/renderer
+```
+
+```js
+import Renderer from '@idraw/renderer';
+
+const renderer = new Renderer({
+  width: 600,
+  height: 400,
+  contextWidth: 600,
+  contextHeight: 400,
+  devicePixelRatio: 1,
+});
+
+const canvas = document.querySelector('canvas');
+renderer.render(canvas, {
+  elements: [
+    {
+      name: "rect-001",
+      x: 10,
+      y: 10,
+      w: 200,
+      h: 100,
+      type: "rect",
+      desc: {
+        bgColor: "#f0f0f0",
+        borderRadius: 20,
+        borderWidth: 10,
+        borderColor: "#bd0b64",
+      },
+    },
+  ]
+})
+
+```
+
+### Events
+
+```js
+renderer.on('load', (e) => {
+  // ...
+})
+renderer.on('loadComplete', (e) => {
+  // ...
+})
+
+renderer.on('drawFrame', (e) => {
+  // ...
+})
+renderer.on('drawFrameComplete', (e) => {
+  // ...
+})
+```
+
+## Documents
+
+- [Documents](https://idraw.js.org/docs/en/) | [中文文档](https://idraw.js.org/docs/zh/) 
+- [Online Playground](https://idraw.js.org/playground/) | [在线API示例](https://idraw.js.org/playground/)
\ No newline at end of file