Skip to content

Commit

Permalink
update readme, add name to parent pom
Browse files Browse the repository at this point in the history
  • Loading branch information
ZenLiuCN committed May 7, 2023
1 parent 530b3e7 commit 6b301d0
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@
</dependencies>

<!--//region deploy -->
<name>Java Units</name>
<url>https://github.com/ZenLiuCN/units</url>
<developers>
<developer>
Expand Down
36 changes: 36 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,39 @@ License as `GPL v2 with classpath exception`.
6. processor: A framework for write CodeGenerator with APT process. JavaPoet required at classpath to enable processors.
7. enhancer: A framework for bytecode enhance on compile time. ByteBuddy required, and also compile time plugin.

# Processor
1. Requires [JavaPoet](https://github.com/square/javapoet) to run;
2. Requires [slf4j-api](https://www.qos.ch/) to run;
# Enhancer
1. Requires [ByteBuddy](https://bytebuddy.net/) to run;
2. Requires [slf4j-api](https://www.qos.ch/) to run;
3. Requires ByteBuddy Plugin for build tool maven or gradle. Eg:
```xml
<plugin>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy-maven-plugin</artifactId>
<version>${byte-buddy-maven-plugin.version}</version>
<executions>
<execution>
<id>post-compile</id>
<phase>compile</phase>
<goals>
<goal>transform</goal>
</goals>
</execution>
<execution>
<id>post-test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>transform-test</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- this will autoload enhancers -->
<classPathDiscovery>true</classPathDiscovery>
</configuration>
</plugin>
```
# Reflect
1. Requires [Caffeine](https://github.com/ben-manes/caffeine) to run.

0 comments on commit 6b301d0

Please sign in to comment.