From 876d0b87e4db2a7dd4e070310666fcd61565c176 Mon Sep 17 00:00:00 2001
From: Alexey Novakov <mein-eingang@eclipso.eu>
Date: Tue, 29 Aug 2023 12:02:47 +0200
Subject: [PATCH] add readme file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6ee69c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Example of stateful job using Apache Flink Scala API 2.12 
+
+To build a fat-jar run:
+
+```bash
+sbt assembly
+```
+
+in the result you will a JAR file at target/scala-2.12/scala-212-savepoint-assembly-0.1.0-SNAPSHOT.jar
+
+Main class for the a Flink job: __com.github.novakovalexey.Main__
+
+# Switch Flink version
+
+In order to switch to Flink 1.15.x or later version, you need to remove second % (percent) sign in the SBT `libraryDependencies` for most of the Flink dependencies. For example:
+
+```scala
+"org.apache.flink" %% "flink-streaming-java"
+```
+change to 
+
+```scala
+"org.apache.flink" % "flink-streaming-java"
+```
+
+this will make SBT to not add a Scala version suffix like _2.12 to the end of artifactId when
+downloading from the Maven central.
\ No newline at end of file