feat: add README.md

.gitignore

@@ -0,0 +1 @@
+.idea/

README.md

@@ -1,2 +1,87 @@
-# influxdb3-java
-The Java Client that provides a simple and convenient way to interact with InfluxDB 3.
+<p align="center">
+    <img src="duke_logo.png" alt="Duke" width="100px">
+</p>
+<p align="center">
+    <a href="https://repo1.maven.org/maven2/com/influxdb3/">
+        <img src="https://img.shields.io/maven-central/v/com.influxdb3/influxdb-client" alt="Maven Central Badge">
+    </a>
+    <a href="https://github.com/bonitoo-io/influxdb3-java/actions/workflows/codeql-analysis.yml">
+        <img src="https://github.com/bonitoo-io/influxdb3-java/actions/workflows/codeql-analysis.yml/badge.svg?branch=main" alt="CodeQL analysis">
+    </a>
+    <a href="https://github.com/bonitoo-io/influxdb3-java/actions/workflows/linter.yml">
+        <img src="https://github.com/bonitoo-io/influxdb3-java/actions/workflows/linter.yml/badge.svg" alt="Lint Code Base">
+    </a>
+    <a href="https://dl.circleci.com/status-badge/redirect/gh/bonitoo-io/influxdb3-java/tree/main">
+        <img src="https://dl.circleci.com/status-badge/img/gh/bonitoo-io/influxdb3-java/tree/main.svg?style=svg" alt="CircleCI">
+    </a>
+    <a href="https://codecov.io/gh/bonitoo-io/influxdb3-java">
+        <img src="https://codecov.io/gh/bonitoo-io/influxdb3-java/branch/main/graph/badge.svg" alt="Code Cov"/>
+    </a>
+    <a href="https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA">
+        <img src="https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social" alt="Community Slack">
+    </a>
+</p>
+
+# InfluxDB 3 Java Client
+
+The Java client that provides an easy and convenient way to interact with InfluxDB 3.
+This package supports both writing data to InfluxDB and querying data using the FlightSQL client,
+which allows you to execute SQL queries against InfluxDB IOx.
+
+## Installation
+
+Add the latest version of the client to your project:
+
+##### Maven dependency:
+
+```xml
+<dependency>
+    <groupId>com.influxdb</groupId>
+    <artifactId>influxdb3-java</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+##### Or when using Gradle:
+
+```groovy
+dependencies {
+    implementation "com.influxdb:influxdb3-java:1.0.0"
+}
+```
+
+## Usage
+
+To start with the client, import the `com.influxdb3` package and create a `InfluxDBClient` by:
+
+```java
+// TBD
+```
+
+to insert data, you can use code like this:
+
+```java
+// TBD
+```
+
+to query your data, you can use code like this:
+
+```java
+// TBD
+```
+
+## Feedback
+
+If you need help, please use our [Community Slack](https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA)
+or [Community Page](https://community.influxdata.com/).
+
+New features and bugs can be reported on GitHub: <https://github.com/bonitoo-io/influxdb3-java>
+
+## Contribution
+
+If you would like to contribute code you can do through GitHub by forking the repository and sending a pull request into
+the `main` branch.
+
+## License
+
+The InfluxDB 3 C# .NET Client is released under the [MIT License](https://opensource.org/licenses/MIT).