docs(readme): readme

readme

Author: mini1798

Readme.md

@@ -40,8 +40,9 @@
     <version>${version}</version>
 </dependency>
 ```
-[版本查看](https://central.sonatype.com/artifact/cn.xiaoandcai/json-diff/3.0.0-RC1-RELEASE/versions)
-2022-04-19 最新版本：3.1.1-RC1-RELEASE
+[版本查看](./VersionHistory.md)
+2022-04-19 最新版本：3.1.2-RC1-RELEASE
+
 
 ```java
 /**
@@ -94,7 +95,6 @@ public class UseExample {
 | mapping          | Map<String, String>            | 将真实字段映射到期望字段，key是真实字段name，value是期望的字段name |
 | ignorePath       | Set\<String\>                  | 当对比的路径完全匹配时会被跳过。遇到数组使用 `[]` 即可。无需填入下标 |
 | ignoreKey        | Set\<String\>                  | 对比object时。或忽略该key。对整个json生效                    |
-| customComparator | Map<String, Class\<JsonNeat\>> | 用户自定义比较器。具体说明见下文                             |
 
 > 在 `2.0.1-RC1-RELEASE` 之后版本中移除了 `keyFunction` 配置参数。可以使用 `ignorePath` 来代替达到同样的效果。
 
@@ -184,7 +184,9 @@ ignoreKey.add("high");
 它配置的key是一个 travelPath 。具体格式参照 ignorePath 。value 则是一个自定义比较器。对于自定义比较器需要继承对应的抽象类。并且实现具体的抽象接口。具体如下：
 
 > 从 3.1.1-RC1-RELEASE 版本开始，自定义比较器的设置移至 JsonDiffOption.getJsonNeatFactory()
-> 不再在原先的Option中设置
+> 不再在原先的Option中设置。如果需要使用自定义比较器。请使用 JsonDiffOption.getJsonNeatFactory().addCustomComparator() 进行设置。
+
+```java
 
 对象比较：
 

VersionHistory.md

@@ -0,0 +1,52 @@
+# 版本列表 📃
+
+## 3.X 🌟
+
+-  **3.1.2-RC1-RELEASE**
+    - 修复数组比较数组越界问题
+
+
+-  **3.1.1-RC1-RELEASE**
+    - 支持自定义比较器添加附加数据
+    - 支持替换默认比较器
+    - 更改自定义比较器设置入口为 JsonDiffOption.getJsonNeatFactory()
+
+
+-  **3.0.3-RC1-RELEASE**
+    - 修复自定义比较器接口范围 
+    - 修复数组对比过程不支持比较长度不相等数组
+    - 修复mapping映射
+    - 丰富测试用例
+
+
+-  **3.0.0-RC1-RELEASE**
+    - 支持自定义比较器 
+    - 支持全局配置
+
+
+## 2.X 🌟
+
+-  **2.0.3-RC1-RELEASE**
+    - 解决ignorePath无效 
+    - 解决配置清理问题
+    - 解决大数类型数据 
+    - 支持更详细的路径展示
+    - 修复对象无法发现多个差异
+
+
+-  **2.0.2-RC1-RELEASE**
+    - 摒弃1.x 版本代码，将代码完全重构 
+    - 返回信息描述添加统一清洗 
+    - fastjson版本更新到 2.0.7
+
+
+## 1.X 🌟
+
+-  **1.2.0**
+    - 补充单测
+    - 代码优化
+    - 支持不同数组元素是不同类型的比较
+
+
+-  **1.0.0**
+    - 基本功能支持

json-diff-common/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <artifactId>json-diff-parent</artifactId>
         <groupId>cn.xiaoandcai</groupId>
-        <version>3.1.1-RC1-RELEASE</version>
+        <version>3.1.2-RC1-RELEASE</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>json-diff-common</artifactId>
-    <version>3.1.1-RC1-RELEASE</version>
+    <version>3.1.2-RC1-RELEASE</version>
 
     <properties>
         <maven.compiler.source>8</maven.compiler.source>

json-diff-core/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <artifactId>json-diff-parent</artifactId>
         <groupId>cn.xiaoandcai</groupId>
-        <version>3.1.1-RC1-RELEASE</version>
+        <version>3.1.2-RC1-RELEASE</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>json-diff-core</artifactId>
-    <version>3.1.1-RC1-RELEASE</version>
+    <version>3.1.2-RC1-RELEASE</version>
 
     <dependencies>
         <dependency>

json-diff-test/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <artifactId>json-diff-parent</artifactId>
         <groupId>cn.xiaoandcai</groupId>
-        <version>3.1.1-RC1-RELEASE</version>
+        <version>3.1.2-RC1-RELEASE</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>json-diff-test</artifactId>
-    <version>3.1.1-RC1-RELEASE</version>
+    <version>3.1.2-RC1-RELEASE</version>
 
     <properties>
         <maven.compiler.source>8</maven.compiler.source>

json-diff/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>json-diff-parent</artifactId>
         <groupId>cn.xiaoandcai</groupId>
-        <version>3.1.1-RC1-RELEASE</version>
+        <version>3.1.2-RC1-RELEASE</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

pom.xml

@@ -7,7 +7,7 @@
     <groupId>cn.xiaoandcai</groupId>
     <artifactId>json-diff-parent</artifactId>
     <!-- mvn clean deploy - -settings /Users/weidian/.m2/settings-out.xml   -->
-    <version>3.1.1-RC1-RELEASE</version>
+    <version>3.1.2-RC1-RELEASE</version>
     <name>JsonDiff</name>
     <url>https://gitee.com/local-li/json-diff</url>
     <description>一款高性能的Json差异发现工具</description>