diff --git a/README.md b/README.md index 04ce49a..7617235 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,9 @@ with JAVA_HOME set **Alternatively you can simply clone/download this repository since it functions as a template too.** -Note that 1JPM is now using **Maven under the hood**, since the complexity as a fully independent build tool -(see version [1.0.3](https://github.com/Osiris-Team/1JPM/blob/1.0.3/src/main/java/JPM.java)) was too high for a single file. Besides, this gives us access to more features, a rich and mature plugin ecosystem, as well as **great IDE compatibility**. 1JPM will take care of generating the pom.xml, downloading the Maven-Wrapper, and then executing Maven as you can see in `main()` below: +Below you can see the example configuration which runs the `clean package` tasks. +This compiles and creates a jar file from your code, and additionally creates the sources, +javadoc and with-dependencies jars. ```java class ThisProject extends JPM.Project { @@ -61,13 +62,13 @@ class ThirdPartyPlugins extends JPM.Plugins{ // 1JPM version 3.0.0 by Osiris-Team: https://github.com/Osiris-Team/1JPM // To upgrade JPM, replace the JPM class below with its newer version +public class JPM { //... } ``` -Above you can see the example configuration which runs the `clean package` tasks. -This compiles and creates a jar file from your code, and additionally creates the sources, -javadoc and with-dependencies jars. +Note that 1JPM is now using **Maven under the hood**, since the complexity as a fully independent build tool +(see version [1.0.3](https://github.com/Osiris-Team/1JPM/blob/1.0.3/src/main/java/JPM.java)) was too high for a single file. Besides, this gives us access to more features, a rich and mature plugin ecosystem, as well as **great IDE compatibility**. 1JPM will take care of generating the pom.xml, downloading the Maven-Wrapper, and then executing Maven as you can see in `main()`. A 1JPM plugin is basically a wrapper around a Maven plugin (its xml), providing easy access to its features, but can also be anything else to make building easier. These third-party plugins can be added simply by appending their Java code inside the ThirdPartyPlugins class.