deploy 0.1.1.RELEASE

lord-of-code · Dec 24, 2017 · 3008c5c · 3008c5c
1 parent 20a8d16
commit 3008c5c
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,82 @@
 通过一定的规则来统一编写各种starter，方便在企业内部进行规则的统一，配置的统一，用法的统一，监控的统一，部署的统一
 方便再进一步的简化springboot和springcloud的使用
 
+## 使用方式
+- pom.xml中加入parent
+```
+<parent>
+    <groupId>com.github.lord-of-code</groupId>
+    <artifactId>loc-framework-starter-parent</artifactId>
+    <version>0.1.1.RELEASE</version>
+    <relativePath/>
+  </parent>
+```
+
+- pom.xml中指定仓库地址(因为springboot2在中央仓库还没有，所以需要指定仓库)
+```
+<repositories>
+  <repository>
+    <id>spring-snapshots</id>
+    <name>Spring Snapshots</name>
+    <url>https://repo.spring.io/snapshot</url>
+    <snapshots>
+      <enabled>true</enabled>
+    </snapshots>
+  </repository>
+  <repository>
+    <id>spring-milestones</id>
+    <name>Spring Milestones</name>
+    <url>https://repo.spring.io/milestone</url>
+    <snapshots>
+      <enabled>false</enabled>
+    </snapshots>
+  </repository>
+</repositories>
+
+<pluginRepositories>
+  <pluginRepository>
+    <id>spring-snapshots</id>
+    <name>Spring Snapshots</name>
+    <url>https://repo.spring.io/snapshot</url>
+    <snapshots>
+      <enabled>true</enabled>
+    </snapshots>
+  </pluginRepository>
+  <pluginRepository>
+    <id>spring-milestones</id>
+    <name>Spring Milestones</name>
+    <url>https://repo.spring.io/milestone</url>
+    <snapshots>
+      <enabled>false</enabled>
+    </snapshots>
+  </pluginRepository>
+</pluginRepositories>
+```
+- pom.xml加入相关插件(插件打出的uber.jar可以直接通过`java -jar uber.jar`来启动)
+```
+<build>
+  <plugins>
+    <plugin>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-maven-plugin</artifactId>
+    </plugin>
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-compiler-plugin</artifactId>
+    </plugin>
+  </plugins>
+</build>
+```
+
+
+## demo程序
+
+具体代码可以参考
+
+- [具体的demo](https://github.com/lord-of-code/loc-framework-demo)
+
+
+
 ## 计划主要的starter
 - springmvc
 - logger

diff --git a/google_checks.xml b/google_checks.xml
@@ -221,15 +221,6 @@
       <property name="target"
           value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
     </module>
-    <module name="JavadocMethod">
-      <property name="scope" value="public"/>
-      <property name="allowMissingParamTags" value="true"/>
-      <property name="allowMissingThrowsTags" value="true"/>
-      <property name="allowMissingReturnTag" value="true"/>
-      <property name="minLineCount" value="2"/>
-      <property name="allowedAnnotations" value="Override, Test"/>
-      <property name="allowThrowsTagsForSubclasses" value="true"/>
-    </module>
     <module name="MethodName">
       <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
       <message key="name.invalidPattern"

diff --git a/pom.xml b/pom.xml
@@ -34,7 +34,7 @@
 
   <properties>
     <main.basedir>${basedir}</main.basedir>
-    <revision>0.1.1-SNAPSHOT</revision>
+    <revision>0.1.1.RELEASE</revision>
   </properties>
 
   <profiles>