docs: add readme

Author: linyimin0812

README.md

@@ -0,0 +1,22 @@
+[中文](README.md) |
+[ENGLISH](README_EN.md)
+
+## 简介
+
+Mybatis-Sql-Viewer是一款增强idea对mybatis支持的插件，主要功能如下：<br/>
+<ul>
+<li>快速从代码跳转到mapper及从mapper返回代码</li>
+<li>mapper文件中的xml语句/方法转换成sql语句，支持参数mock、数据源配置、sql执行</li>
+</ul>
+
+## 安装
+
+`IntelliJ IDEA` > `Preferences` > `Plugins` > `Marketplace` > `Search for "mybatis sql view"` > `Install Plugin` > `Restart IntelliJ IDEA`
+
+## 使用
+
+![](https://linyimin-picture.oss-cn-hangzhou.aliyuncs.com/how-to-use.gif)
+
+## 注意
+
+由于使用了mybatis包将xml转成sql语句，会对整个项目进行编译，第一次使用时，加载会有一定耗时，请耐心等待。

README_EN.md

@@ -0,0 +1,23 @@
+[中文](README.md) |
+[ENGLISH](README_EN.md)
+
+## Description
+
+Mybatis-Sql-Viewer is an enhanced plugin for idea to support mybatis,here is the main functions:
+<ul>
+    <li>navigate from the code to mapper and from the mapper back to code</li>
+    <li>The xml statement/method in the mapper file convert to sql statement, which supports parameters mock, data source configuration, and sql execution</li>
+</ul>
+
+## Install
+
+`IntelliJ IDEA` > `Preferences` > `Plugins` > `Marketplace` > `Search for "mybatis sql view"` > `Install Plugin` > `Restart IntelliJ IDEA`
+
+## How to Use
+
+![](https://linyimin-picture.oss-cn-hangzhou.aliyuncs.com/how-to-use.gif)
+
+
+## Notice
+
+Since the mybatis package is used to convert xml to sql statements, the entire project will be compiled, and the first time you use it, the loading will be take some time, so please be patient.

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'org.linyimin'
-version '1.0-SNAPSHOT'
+version '1.0.0'
 
 repositories {
     maven { url 'https://maven.aliyun.com/repository/public/' }
@@ -28,8 +28,14 @@ intellij {
 }
 patchPluginXml {
     changeNotes = """
-      Add change notes here.<br>
-      <em>most HTML tags may be used</em>
+      <ul>
+        <li>navigate from the code to mapper and from the mapper back to code</li>
+        <li>The xml statement/method in the mapper file convert to sql statement, which supports parameters mock, data source configuration, and sql execution</li>
+    </ul>
+    <ul>
+        <li>快速从代码跳转到mapper及从mapper返回代码</li>
+        <li>mapper文件中的xml语句/方法转换成sql语句，支持参数mock、数据源配置、sql执行</li>
+    </ul>
     """
 }
 

src/main/java/io/github/linyimin/plugin/service/SqlParamGenerateService.java

@@ -272,12 +272,8 @@ private Map<String, Object> getFieldFromClass(PsiClass psiClass) {
                     param.put(fieldName, temp);
                 }
             }
-
-
         }
-
         return param;
-
     }
 
     /**

src/main/resources/META-INF/plugin.xml

@@ -7,7 +7,27 @@
     <idea-version since-build="IU-201" />
 
     <description><![CDATA[
-    将mapper文件中的xml语句转换成sql语句，支持参数mock，sql复制，执行
+    Mybatis-Sql-Viewer Plugin is a idea plugin for mybatis. <br />
+
+    <img src="https://linyimin-picture.oss-cn-hangzhou.aliyuncs.com/how-to-use.gif" />
+
+    <br/>
+
+    Mybatis-Sql-Viewer is an enhanced plugin for idea to support mybatis,here is the main functions:
+    <ul>
+        <li>navigate from the code to mapper and from the mapper back to code</li>
+        <li>The xml statement/method in the mapper file convert to sql statement, which supports parameters mock, data source configuration, and sql execution</li>
+    </ul>
+
+    Mybatis-Sql-Viewer是一款增强idea对mybatis支持的插件，主要功能如下：<br/>
+    <ul>
+        <li>快速从代码跳转到mapper及从mapper返回代码</li>
+        <li>mapper文件中的xml语句/方法转换成sql语句，支持参数mock、数据源配置、sql执行</li>
+    </ul>
+
+    <br/>
+    <a href="https://github.com/linyimin-bupt/mybatis-sql-viewer">Github</a> Welcome to star(欢迎star)
+    <br/>
     ]]></description>
 
     <!-- please see https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html