From 74d701e63be397475635f52d65d77ce22be2fa79 Mon Sep 17 00:00:00 2001
From: "Erik C. Thauvin" <erik@thauvin.net>
Date: Mon, 30 Oct 2023 12:57:06 -0700
Subject: [PATCH] Added README

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4550dac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# [bld](https://rife2.com/bld) Extension for [Spring Boot](https://spring.io/projects/spring-boot)
+
+
+[![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)
+[![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-spring-boot/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-spring-boot/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-spring-boot)
+[![GitHub CI](https://github.com/rife2/bld-spring-boot/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 create a Spring Boot executable Java Archive (JAR) from the current project:
+
+```java
+@@BuildCommand(summary = "Creates an executable JAR for the project")
+public void bootjar() throws Exception {
+    new BootJarOperation()
+            .fromProject(this)
+            .execute();
+}
+```
+
+```text
+./bld compile bootjar
+```
+
+To create a Spring Boot executable Web Archive (WAR) from the current project:
+
+```java
+@BuildCommand(summary = "Create an executable WAR for the project")
+public void bootwar() throws Exception {
+    new BootWarOperation()
+            .fromProject(this)
+            .execute();
+}
+```
+
+```text
+./bld compile bootwar
+```
+
+Please check the [BootJarOperation documentation](https://rife2.github.io/bld-spring-boot/rife/bld/extension/BootJarOperation.html#method-summary)
+or [BootWarOperation documentation](https://rife2.github.io/bld-spring-boot/rife/bld/extension/BootWarOperation.html#method-summary)
+for all available configuration options.