documentation and cleanup

viadee · Aug 29, 2019 · a74d055 · a74d055
1 parent f843c68
commit a74d055
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 78 deletions.
diff --git a/.classpath b/.classpath
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,3 @@
+Dockerfile
+*.class
+.gitignore
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 /.settings/
 /target/
 *.class
+.project
+.classpath
 
diff --git a/.project b/.project
diff --git a/README.md b/README.md
@@ -1 +1,21 @@
-# k8s-demo-app
+# Simple demo app for k8s
+The goal is to have a simple app which can be used to demonstrate some features you can use in k8s.
+
+This demo app uses spring boot and a h2-database as technologies.
+
+## Features
+ - endpoint for heath check, which can be controled via environment variable
+ - endpoint for readiness check, which can be controled via rest endpoint
+ - background-color and some text customizable via spring config
+
+ ## Running
+ Run with docker
+ ```shell
+ docker run viadee/k8s-demo-app:latest
+ ```
+
+ ## Building
+ This is a simple maven project. Just run ```maven package```.
+
+ Or just do a local docker build: ```docker build -t imagename .```
+ Then you can run the container locally.