编写readme

README.md

@@ -1,12 +1,13 @@
-#### 郑重声明
+#### <font face="幼圆"  color = "#F53B45">**郑重声明**</font>
+
 &emsp;&emsp;class-winter是本人在学习完[class-final(v1.1.9)](https://gitee.com/roseboy/classfinal)后，仿照class-final进行编写的，整体思路与class-final一致，代码部分(约20%~30%)复用了class-final中的代码。一定程度上，可将class-winter看作是class-fianl的一个分支。
 
-## 功能与特性
+### <font  face="幼圆" color = "#3399EA" >功能与特性</font>
 - 支持war加密。
 - 支持jar(普通jar+可执行jar)加密。
 
-## 加密方式
-- 方式一：通过maven插件自动加密。
+### <font  face="幼圆" color = "#3399EA" >加密方式</font>
+- <font face="幼圆"  color = "#86CA5E">**方式一**</font>：通过maven插件自动加密。
   ```xml
   <!--
       class-winter插件
@@ -40,7 +41,7 @@
   </plugin>
   ```
 
-- 方式二：通过class-winter-core.jar主动加密。
+- <font face="幼圆"  color = "#86CA5E">**方式二**</font>：通过class-winter-core.jar主动加密。
 
   ```bash
   java -jar class-winter-core-${version}.jar originJarOrWar=${要加密的项目.jar或.war包} includePrefix=${加密范围} [k3=v3 k4=v4 ...]
@@ -51,7 +52,7 @@
   java -jar class-winter-core-${version}.jar k1="v1" k2="v2"
   ```
 
-## 加密参数说明
+### <font  face="幼圆" color = "#3399EA" >加密参数</font>
 <table>
   <tr align="center">
     <td>参数</td>
@@ -62,22 +63,26 @@
   <tr align="center">
     <td>originJarOrWar</td>
     <td>是</td>
-    <td>指定要加密的jar/war文件</td>
+    <td>指定要加密的jar/war文件<br/>注：当使用maven插件进行自动加密时，无此参数。</td>
     <td>originJarOrWar=/my-project.jar</td>
   </tr>
     <tr align="center">
     <td>includePrefix</td>
     <td>是</td>
     <td>通过前缀匹配的形式定位要加密的class
-注:多个通过逗号分割。</td>
+    <br/>
+注：多个通过逗号分割。</td>
     <td>includePrefix=com
+    <br/>
 includePrefix=com,org</td>
   </tr>
     <tr align="center">
     <td>excludePrefix</td>
     <td>否</td>
     <td>通过前缀匹配的形式排除class，不对其加密
-注:多个通过逗号分割。
+    <br/>
+注：多个通过逗号分割。
+<br/>
 注:excludePrefix优先级高于includePrefix。</td>
     <td>excludePrefix=com.example.service,com.example.util.StrUtil.class</td>
   </tr>
@@ -85,52 +90,66 @@ includePrefix=com,org</td>
     <td>finalName</td>
     <td>否</td>
     <td>指定加密后生成的jar包名
-注:若finalName与加密的包一致，那么生成的加密后的包会覆盖原来的包。</td>
+    <br/>
+注：若finalName与加密的包一致，那么生成的加密后的包会覆盖原来的包。</td>
     <td>finalName=mine-project</td>
   </tr>
     <tr align="center">
     <td>password</td>
     <td>否</td>
     <td>主动指定密码
-注:密码不能包含空格和逗号。</td>
+    <br/>
+注：密码不能包含空格和逗号。</td>
     <td>password=123456</td>
   </tr>
     <tr align="center">
     <td>includeLibs</td>
     <td>否</td>
     <td>指定将lib包也纳入加密范围内
+    <br/>
 注:多个通过逗号分割。
-注:lib中的class是否会被加密，还得由includePrefix和excludePrefix决定。</td>
+<br/>
+注：lib中的class是否会被加密，还得由includePrefix和excludePrefix决定。</td>
     <td>includeLibs=a.jar,b.jar</td>
   </tr>
     <tr align="center">
     <td>alreadyProtectedLibs</td>
     <td>否</td>
     <td>指明项目所以来的lib中，哪些lib本身就已经是被class-winter加密了的
-注:多个通过逗号分割。
+    <br/>
+注：多个通过逗号分割。
+<br/>
 注:主要用于处理第三方提供的由class-winter加密了的依赖包的场景。
-注:若lib需要密码，那么需要在指定lib的同时通过冒号接上密码。
-注:如果lib有密码，那么密码不能包含逗号。</td>
+<br/>
+注：若lib需要密码，那么需要在指定lib的同时通过冒号接上密码。
+<br/>
+注：如果lib有密码，那么密码不能包含逗号。</td>
     <td>alreadyProtectedLibs=a.jar,b.jar
+    <br/>
 alreadyProtectedLibs=a.jar,b.jar:pwd123
+<br/>
 alreadyProtectedLibs=a.jar:pwd1,b.jar:2</td>
   </tr>
     <tr align="center">
     <td>supportFile</td>
     <td>否</td>
     <td>指定一个加密辅助jar文件（或jar文件所在的目录）
-注:当为目录时，该目录(含子孙目录)下的所有jar都会被作采集作为辅助文件。
+    <br/>
+注：当为目录时，该目录(含子孙目录)下的所有jar都会被作采集作为辅助文件。
+<br/>
 注:主要用于解决因ClassNotFound导致的加密失败问题。</td>
     <td>supportFile=/abc.jar
+    <br/>
 supportFile=/libs</td>
   </tr>
     <tr align="center">
     <td>tips</td>
     <td>否</td>
     <td>指定提示语。
-注:当直接使用加密后的jar/war时，用到了加密了的类后，会先System.err.println输出此tips,然后System.exit退出程序。</td>
+    <br/>
+注：当直接使用加密后的jar/war时，用到了加密了的类后，会先System.err.println输出此tips,然后System.exit退出程序。</td>
     <td>windows示例：tips=”请不要直接使用混淆后的jar/war”
-
+<br/>
 linux示例：tips=’请不要直接使用混淆后的jar/war’</td>
   </tr>
     <tr align="center">
@@ -142,64 +161,62 @@ linux示例：tips=’请不要直接使用混淆后的jar/war’</td>
 </table>
 
 
-## 解密(启动)
+### <font  face="幼圆" color = "#3399EA" >解密(启动)</font>
 通过-javaagent指定代理进行解密启动。
-#### jar解密(启动)
-示例说明
-
-```bash
-# 假设your-project-encrypted.jar是由class-winter加密后的包，那么你可以这么启动
-java -javaagent:/your-project-encrypted.jar -jar /your-project-encrypted.jar
-# 也可以用class-winter-core-1.0.0.jar
-java -javaagent:/class-winter-core-1.0.0.jar -jar /your-project-encrypted.jar
-# 或者指定参数
-# java -javaagent:/your-project-encrypted.jar=debug=true,password=pwd12345 -jar /your-project-encrypted.jar
-# 参数可以引起来(linux)
-# java -javaagent:/your-project-encrypted.jar='debug=true,password=pwd12345' -jar /your-project-encrypted.jar
-# 参数可以引起来(windows)
-# java -javaagent:/your-project-encrypted.jar="debug=true,password=pwd12345" -jar /your-project-encrypted.jar
-```
-
-#### war解密(启动):
-- linux方式一
-
-  编辑tomcat/bin/catalina.sh文件，在最上面加上
-
+- #### <font  face="幼圆" color = "#86CA5E" >jar解密(启动)</font>
   ```bash
-  # 如果你有参数， 那么 -javaagent:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
-  CATALINA_OPTS="$CATALINA_OPTS -javaagent:/class-winter-core-1.0.0.jar=debug=true";
-  export CATALINA_OPTS;
+  # 假设your-project-encrypted.jar是由class-winter加密后的包，那么你可以这么启动
+  java -javaagent:/your-project-encrypted.jar -jar /your-project-encrypted.jar
+  # 也可以用class-winter-core-1.0.0.jar
+  # java -javaagent:/class-winter-core-1.0.0.jar -jar /your-project-encrypted.jar
+  # 或者指定参数
+  # java -javaagent:/your-project-encrypted.jar=debug=true,password=pwd12345 -jar /your-project-encrypted.jar
+  # 参数可以引起来(linux)
+  # java -javaagent:/your-project-encrypted.jar='debug=true,password=pwd12345' -jar /your-project-encrypted.jar
+  # 参数可以引起来(windows)
+  # java -javaagent:/your-project-encrypted.jar="debug=true,password=pwd12345" -jar /your-project-encrypted.jar
   ```
 
-- linux方式二
+- #### <font  face="幼圆" color = "#86CA5E" >war解密(启动)</font>
+  - linux方式一
 
-  在tomcat/bin目录下创建setenv.sh文件，并写上
+    编辑tomcat/bin/catalina.sh文件，在最上面加上
 
-  ```bash
-  # 如果你有参数， 那么 -javaagent:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
-  JAVA_OPTS="$JAVA_OPTS -javaagent:/class-winter-core-1.0.0.jar=debug=true";
-  export JAVA_OPTS;
-  ```
+    ```bash
+    # 如果你有参数， 那么 -javaagent:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
+    CATALINA_OPTS="$CATALINA_OPTS -javaagent:/class-winter-core-1.0.0.jar=debug=true";
+    export CATALINA_OPTS;
+    ```
 
-- windows方式一
+  - linux方式二
 
-  编辑tomcat/bin/catalina.bat文件，在@echo off后加上catalina参数
+    在tomcat/bin目录下创建setenv.sh文件，并写上
 
-  ```bash
-  rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
-  set CATALINA_OPTS="-javaagent:D:/class-winter-core-1.0.0.jar"
-  ```
+    ```bash
+    # 如果你有参数， 那么 -javaagent:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
+    JAVA_OPTS="$JAVA_OPTS -javaagent:/class-winter-core-1.0.0.jar=debug=true";
+    export JAVA_OPTS;
+    ```
 
-- windows方式二
+  - windows方式一
 
-  在tomcat/bin目录下创建setenv.bat文件，并写上
+    编辑tomcat/bin/catalina.bat文件，在@echo off后加上catalina参数
 
-  ```bash
-  rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
-  set JAVA_OPTS="-javaagent:D:/class-winter-core-1.0.0.jar"
-  ```
+    ```bash
+    rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
+    set CATALINA_OPTS="-javaagent:D:/class-winter-core-1.0.0.jar"
+    ```
+
+  - windows方式二
+
+    在tomcat/bin目录下创建setenv.bat文件，并写上
+
+    ```bash
+    rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
+    set JAVA_OPTS="-javaagent:D:/class-winter-core-1.0.0.jar"
+    ```
 
-## 解密参数说明
+### <font  face="幼圆" color = "#3399EA" >解密参数</font>
 <table>
   <tr align="center">
     <td>参数</td>