From 30356f3326eb071de49cd5ad0201518480327dd0 Mon Sep 17 00:00:00 2001
From: "Erik C. Thauvin" <erik@thauvin.net>
Date: Sat, 4 Nov 2023 02:56:48 -0700
Subject: [PATCH] Added README

---
 README.md                                     | 31 +++++++++++++++++++
 examples/.idea/vcs.xml                        |  6 ++++
 .../bld/java/com/example/ExampleBuild.java    |  1 -
 3 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 create mode 100644 examples/.idea/vcs.xml

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d27f63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# [Kotlin](https://kotlinlang.org/) Extension for [b<span style="color:orange">l</span>d](https://rife2.com/bld) 
+
+[![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
+[![Kotlin](https://img.shields.io/badge/kotlin-1.9.20-7f52ff.svg)](https://kotlinlang.org)
+[![bld](https://img.shields.io/badge/1.7.3-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld)
+[![Release](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/releases/com/uwyn/rife2/bld-kotlin/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-spring-boot)
+[![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-kotlin/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-spring-boot)
+[![GitHub CI](https://github.com/rife2/bld-kotlin/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-spring-boot/actions/workflows/bld.yml)
+
+To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).
+
+To compile the Kotlin source code from the current project:
+
+```java
+@BuildCommand(summary = "Compile the Kotlin project")
+public void compile() throws IOException {
+    new CompileKotlinOperation()
+            .fromProject(this)
+            .compileOptions("-verbose")
+            .execute();
+}
+```
+
+```text
+./bld compile
+```
+
+Please check the [Compile Operation documentation](https://rife2.github.io/bld-kotlin/rife/bld/extension/CompileKotlinOperation.html#method-summary) for all available configuration options.
+
+You may also want to look at the [example project](https://github.com/rife2/bld-kotlin/tree/main/examples/).
diff --git a/examples/.idea/vcs.xml b/examples/.idea/vcs.xml
new file mode 100644
index 0000000..6c0b863
--- /dev/null
+++ b/examples/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/examples/src/bld/java/com/example/ExampleBuild.java b/examples/src/bld/java/com/example/ExampleBuild.java
index a14bbbe..5e3f929 100644
--- a/examples/src/bld/java/com/example/ExampleBuild.java
+++ b/examples/src/bld/java/com/example/ExampleBuild.java
@@ -3,7 +3,6 @@
 import rife.bld.BaseProject;
 import rife.bld.BuildCommand;
 import rife.bld.extension.CompileKotlinOperation;
-import rife.bld.operations.RunOperation;
 
 import java.io.IOException;
 import java.util.List;