updatepacks

.gitignore

@@ -20,7 +20,6 @@ target/
 *.war
 *.nar
 *.ear
-*.zip
 *.tar.gz
 *.rar
 

README.md

@@ -4,15 +4,70 @@
 # Custom-Crops
 StardewValley Like Farming System
 
-### How to buy
+### Support the developer
 
 https://afdian.net/@xiaomomi
 
 https://polymart.org/resource/customcrops.2625
 
-### How to compile
+## How to build
 
-./gradlew build and get the jar in /target folder
+### Windows
+
+#### Command Line
+Install JDK 17 and set the JDK installation path to JAVA_HOME as an environment variable.\
+Start powershell and change directory to the project folder.\
+Execute ".\gradlew build" and get the jar at /target/CustomFishing-plugin-version.jar.
+
+#### IDE
+Import the project and execute gradle build action.
+
+## Use CustomFishing API
+
+### Maven
+
+```
+<repositories>
+  <repository>
+    <id>jitpack</id>
+    <url>https://jitpack.io/</url>
+  </repository>
+</repositories>
+```
+```
+<dependencies>
+  <dependency>
+    <groupId>com.github.Xiao-MoMi</groupId>
+    <artifactId>Custom-Crops</artifactId>
+    <version>{LATEST}</version>
+    <scope>provided</scope>
+  </dependency>
+</dependencies>
+```
+### Gradle (Groovy)
+
+```
+repositories {
+    maven { url 'https://jitpack.io' }
+}
+```
+```
+dependencies {
+    compileOnly 'com.github.Xiao-MoMi:Custom-Crops:{LATEST}'
+}
+```
+### Gradle (Kotlin)
+
+```
+repositories {
+    maven("https://jitpack.io/")
+}
+```
+```
+dependencies {
+    compileOnly("com.github.Xiao-MoMi:Custom-Crops:{LATEST}")
+}
+```
 
 ### API Guide
 ```access transformers