Merge pull request #3 from ClickHouse/add-readme

First version of README.md

README.md

@@ -0,0 +1,26 @@
+<div align="center">
+<p>
+<img src="https://github.com/ClickHouse/clickhouse-js/blob/a332672bfb70d54dfd27ae1f8f5169a6ffeea780/.static/logo.svg" width="200px" align="center">
+</p>
+<h1>Apache Beam ClickHouseIO </h1>
+</div>
+
+## About the Project
+
+The current Github project main purpose 
+* Provide easy use of [ClickHouseIO](https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/io/clickhouse/ClickHouseIO.html)
+* Continues testing with [ClickHouse Cloud](https://clickhouse.com/cloud)
+* Example of using ClickHouseIO with Apache Beam (Complete Pipeline)
+
+## Continues testing
+To make sure that latest Apache Beam version works with ClickHouse Cloud we have created a Nightly git workflow that runs the e2e beam pipeline every day.
+This will make sure that the k latest versions of Apache Beam work with ClickHouse Cloud.
+
+## Examples 
+
+A Full Maven [example](https://github.com/ClickHouse/clickhouse-beam-connector/tree/main/example/mvn) with a pom.xml definition
+
+## Docs 
+
+* [ClickHouse Docs](https://clickhouse.com/docs/en/integrations/apache-beam)
+* [Apache Beam ClickHouseIO Docs](https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/io/clickhouse/ClickHouseIO.html)