From 217c35ec76fa725527d73b64a7350dadd3e34314 Mon Sep 17 00:00:00 2001
From: Geert Bevin <gbevin@uwyn.com>
Date: Sun, 12 Feb 2023 11:45:36 -0500
Subject: [PATCH] Added readme and updated git ignore.

---
 .gitignore |  3 +++
 README.md  | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 1b6985c..73ca0bf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,6 @@
 
 # Ignore Gradle build output directory
 build
+
+# Ignore IDEA project files
+.idea
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4cbc969
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# RIFE2 bootstrap project structure
+
+This project helps you to get started with a RIFE2 web application and Gradle.
+
+You'll find all the pieces that are explained in the first sections of
+[the documentation](https://github.com/gbevin/rife2/wiki) neatly contained
+in this one project.
+
+It's ready to run, package and deploy ... and for you to have fun developing
+in a very iterative, intuitive and rewarding way.
+
+For all things RIFE2, head on to the project website:
+[https://rife2.com](https://rife2.com)
+
+## Running the server
+
+```bash
+./gradlew clean run
+```
+
+Go to:
+
+[http://localhost:8080/](http://localhost:8080/)
+
+
+## Deploying the app
+
+```bash
+./gradlew clean war
+```
+
+The resulting archive will be in:
+`war/build/libs`
+
+
+## Making an UberJar
+
+
+```bash
+./gradlew clean uberJar
+```
+
+Then run it with:
+
+```bash
+java -jar app/build/libs/hello-uber-1.0.jar
+```
\ No newline at end of file