From cb8bd913133b5fd7f2573b6f66ab219ef6ead802 Mon Sep 17 00:00:00 2001
From: zhouyongfei <zhouyongfei@huawei.com>
Date: Wed, 15 Sep 2021 14:32:33 +0800
Subject: [PATCH] refresh readme

Signed-off-by: zhouyongfei <zhouyongfei@huawei.com>
---
 README.md    | 43 +++++++++++++++++++++++++++++++------------
 README_zh.md | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 71 insertions(+), 12 deletions(-)
 create mode 100644 README_zh.md

diff --git a/README.md b/README.md
index 9e01cbf..8a3e68a 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,41 @@
 # miscservices_inputmethod
 
-#### 介绍
-输入法框架
+####Introduction
 
+Input Method Framework, is used to connect the application and input method. the application can input text through the input method
 
-#### 安装教程
+####Warehouse path
 
-1.  随版本烧录即可带上
+/base/miscservices/inputmethod
 
-#### 使用说明
+####Introduction to framework code
 
-1.  在编辑属性的控件中进行点击操作，即可通过输入法框架调起默认输入法应用
-2.  通过输入法应用可以进行打字，并上屏输入字符到应用客户端
+The input method framework currently has four modules, as follows:
 
-#### 参与贡献
+1. Application client
+Path: /base/miscservices/inputmethod/frameworks/inputmethod_controller
+Function: realize the service delivery of application and input method framework, including the binding between application and input method service, application display and hiding request for input method, etc
 
-1.  Fork 本仓库
-2.  新建 Feat_master 分支
-3.  提交代码
-4.  新建 Pull Request
+2. Input method client
+Path: /base/miscservices/inputmethod/frameworks/inputmethod_ability
+Function: the intermediate bridge between input method framework service and input method delivery, including monitoring the current status of input method, etc
 
+3. Input method service
+Path: /base/miscservices/inputmethod/services
+Function: as the core of the input method framework, the main processing logic of the input method is completed here
+
+4. Input method JS interface
+Path: /base/miscservices/inputmethod/interfaces/kits/JS
+Function: the temporarily exposed JS interface is mainly reserved for calling input methods
+
+####Main functions supported by the framework
+
+1. Click in the edit attribute control to invoke the default input method application through the input method framework
+2. Typing can be carried out through the input method application, and characters can be input to the application client on the screen
+
+####Participation contribution
+
+1. Fork warehouse
+2. Submission code
+3. Create a new pull request
+4. Commit is complete
diff --git a/README_zh.md b/README_zh.md
new file mode 100644
index 0000000..8dc68e0
--- /dev/null
+++ b/README_zh.md
@@ -0,0 +1,40 @@
+# miscservices_inputmethod
+
+#### 介绍
+输入法框架，主要作用是拉通应用和输入法，保证应用可以通过输入法进行文本输入
+
+#### 仓路径
+/base/miscservices/inputmethod
+
+#### 框架代码介绍
+输入法框架目前有四大模块，具体如下：
+
+1.  应用客户端
+路径：/base/miscservices/inputmethod/frameworks/inputmethod_controller
+作用：实现应用和输入法框架服务交付，包括应用与输入法服务的绑定、应用对输入法的显示和隐藏请求等等
+
+2.  输入法客户端
+路径：/base/miscservices/inputmethod/frameworks/inputmethod_ability
+作用：实现输入法框架服务与输入法交付的中间桥梁，包括监听输入法当前的状态等等
+
+3.  输入法服务
+路径：/base/miscservices/inputmethod/services
+作用：作为输入法框架的核心，输入法的主要处理逻辑都是在这里完成
+
+4.  输入法Js接口
+路径：/base/miscservices/inputmethod/interfaces/kits/js
+作用：暂时对外暴露的js接口，主要是留给输入法进行调用使用的
+
+#### 框架主要支持功能
+
+1.在编辑属性的控件中进行点击操作，即可通过输入法框架调起默认输入法应用
+
+2.通过输入法应用可以进行打字，并上屏输入字符到应用客户端
+
+#### 参与贡献
+
+1.  Fork 本仓库
+2.  提交代码
+3.  新建 Pull Request
+4.  commit完成即可
+
-- 
Gitee