From 8b09d65e75bd42ba97b9028694098f5156239f23 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C4=B1v=C4=B1lc=C4=B1m=20=C4=B0=2E?= <info@yigitovski.com>
Date: Mon, 23 Sep 2024 23:49:43 +0300
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..06f0c37
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# scala-on-alpine
+An actually decent Scala image based on Alpine that is still huge because of Scala
+
+# why?
+- The OpenJDK images were orphaned.
+- The `ibmjava` image is huge due to being based on Ubuntu. (see also [the description of the Alpine image comparing it against Ubuntu](https://hub.docker.com/_/alpine))
+- There is not an image dedicated for building Scala apps
+
+# how to use
+```dockerfile
+FROM ghcr.io/sparkles-laurel/scala-on-alpine:0.1.1
+
+RUN apk update && apk upgrade
+
+# Set the working directory
+WORKDIR /app
+
+# Copy the project files
+COPY . /app
+
+# Run sbt to download dependencies and compile the project
+RUN sbt --verbose update && sbt --verbose compile
+
+CMD ["sbt", "run"]
+```