From 8062291fc68786a30156a91bc1c012d67bab91d4 Mon Sep 17 00:00:00 2001
From: wangqun <wangqun@baidu.com>
Date: Wed, 18 Mar 2020 17:48:29 +0800
Subject: [PATCH] [doc]add the yolo example user doc

[doc]add the yolo example user doc
---
 web/examples/README.md    | 35 +++++++++++++++++++++++++++++++++++
 web/examples/README_cn.md |  2 +-
 2 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 web/examples/README.md

diff --git a/web/examples/README.md b/web/examples/README.md
new file mode 100644
index 0000000000..96afab52b0
--- /dev/null
+++ b/web/examples/README.md
@@ -0,0 +1,35 @@
+# PaddleJS Examples
+
+Baidu paddlejs uses the ready-made JavaScript model or transforms the paddle model to run in the browser.
+
+## Demonstration
+
+At present, tiny Yolo model can run within 30ms for web project, which is enough for general real-time scenarios.
+
+## Browser coverage
+
+* PC: Chrome
+* Mac: Chrome
+* Android: Baidu App and QQ Browser
+
+## Building deployment
+
+```bash
+cd web                        # Go to root
+npm i                         # Installation dependency
+mkdir dist                    # Create resource directory
+cd dist                       # Enter resource directory
+git clone https://github.com/DerekYangMing/Paddle-Web-Models.git # Get models
+mv Paddle-Web-Models/separablemodel .                            # Move the model to the designated location
+cd ..                         # Root directory
+npm run tinyYolo              # run tinyYolo 
+```
+
+## Preview
+
+1. Open url: https://localhost:端口号/
+2. Click the upload picture button。
+
+## Result
+
+![image](./tinyYolo/demoshow.png)
diff --git a/web/examples/README_cn.md b/web/examples/README_cn.md
index ef10c63bca..a0f34d7a41 100644
--- a/web/examples/README_cn.md
+++ b/web/examples/README_cn.md
@@ -29,7 +29,7 @@ npm run tinyYolo              # 启动 tinyYolo 在线推理服务
 
 ## 如何预览 demo
 
-1. 在浏览器中打开url: https://localhost:8123/
+1. 在浏览器中打开url: https://localhost:端口号/
 2. 点击【开始检测】按钮。
 3. 将人脸对准摄像头，没有问题的话，可以正常检测到人脸。
 
-- 
GitLab