This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/flink-connector-elasticsearch.git
commit 66210e9db21875a1edad93d785b4e95d7690293e
Author: Chesnay Schepler <ches...@apache.org>
AuthorDate: Wed Sep 14 11:23:46 2022 +0200
[hotfix] Add a proper README
---
README.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 69 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 84c5808..8550aca 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,69 @@
-# flink-connector-elasticsearch
+# Apache Flink Elasticsearch Connector
+
+This repository contains the official Apache Flink Elasticsearch connector.
+
+## Apache Flink
+
+Apache Flink is an open source stream processing framework with powerful
stream- and batch-processing capabilities.
+
+Learn more about Flink at
[https://flink.apache.org/](https://flink.apache.org/)
+
+## Building the Apache Flink Elasticsearch Connector from Source
+
+Prerequisites:
+
+* Unix-like environment (we use Linux, Mac OS X)
+* Git
+* Maven (we recommend version 3.8.6)
+* Java 11
+
+```
+git clone https://github.com/apache/flink-connector-elasticsearch.git
+cd flink-connector-elasticsearch
+./mvn clean package -DskipTests
+```
+
+The resulting jars can be found in the `target` directory of the respective
module.
+
+## Developing Flink
+
+The Flink committers use IntelliJ IDEA to develop the Flink codebase.
+We recommend IntelliJ IDEA for developing projects that involve Scala code.
+
+Minimal requirements for an IDE are:
+* Support for Java and Scala (also mixed projects)
+* Support for Maven with Java and Scala
+
+### IntelliJ IDEA
+
+The IntelliJ IDE supports Maven out of the box and offers a plugin for Scala
development.
+
+* IntelliJ download:
[https://www.jetbrains.com/idea/](https://www.jetbrains.com/idea/)
+* IntelliJ Scala Plugin:
[https://plugins.jetbrains.com/plugin/?id=1347](https://plugins.jetbrains.com/plugin/?id=1347)
+
+Check out our [Setting up
IntelliJ](https://nightlies.apache.org/flink/flink-docs-master/flinkDev/ide_setup.html#intellij-idea)
guide for details.
+
+## Support
+
+Don’t hesitate to ask!
+
+Contact the developers and community on the [mailing
lists](https://flink.apache.org/community.html#mailing-lists) if you need any
help.
+
+[Open an issue](https://issues.apache.org/jira/browse/FLINK) if you found a
bug in Flink.
+
+## Documentation
+
+The documentation of Apache Flink is located on the website:
[https://flink.apache.org](https://flink.apache.org)
+or in the `docs/` directory of the source code.
+
+## Fork and Contribute
+
+This is an active open-source project. We are always open to people who want
to use the system or contribute to it.
+Contact us if you are looking for implementation tasks that fit your skills.
+This article describes [how to contribute to Apache
Flink](https://flink.apache.org/contributing/how-to-contribute.html).
+
+## About
+
+Apache Flink is an open source project of The Apache Software Foundation (ASF).
+The Apache Flink project originated from the
[Stratosphere](http://stratosphere.eu) research project.
+
