added README and LICENSE

maxid · Nov 13, 2017 · c9a7f30 · c9a7f30
1 parent 4f31c59
commit c9a7f30
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/LICENSE → LICENSE.md b/LICENSE → LICENSE.md
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# FlinkEsper
+
+An attempt to use Esper stream processing engine within Apache Flink as alternative to FlinkCEP.
+
+
+### Prerequisites
+
+ * Java 8
+ * Maven
+ * git
+
+
+```
+git clone https://github.com/phil3k3/flink-esper.git
+flink-esper
+mvn clean package
+```
+
+The flink-esper library is now availble as JAR with dependencies in the flink-esper/target subdirectory.
+
+## Contributing
+
+Anybody who has sincere interest into making a contribution of any kind is invited to do so.
+
+## Authors
+
+* **Philip L**
+
+## License
+
+This project is licensed under the Apache License - see the [LICENSE.md](LICENSE.md) file for details