From e4a1b7fa3ee83d995bb67038e8525803a94b5cab Mon Sep 17 00:00:00 2001
From: zhiheng123 <903292776@qq.com>
Date: Thu, 28 Nov 2024 23:46:47 +0800
Subject: [PATCH] docs: add readme.md

Signed-off-by: zhiheng123 <903292776@qq.com>
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index ad3951d..e6b7de6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,14 @@
 # mtconnect-java
 
 ![License](https://img.shields.io/badge/license-Apache2.0-green) ![Language](https://img.shields.io/badge/language-Java-blue.svg) [![version](https://img.shields.io/github/v/tag/protocol-laboratory/mtconnect-java?label=release&color=blue)](https://github.com/protocol-laboratory/mtconnect-java/releases) [![codecov](https://codecov.io/gh/protocol-laboratory/mtconnect-java/branch/main/graph/badge.svg)](https://codecov.io/gh/protocol-laboratory/mtconnect-java)
+
+### Overview
+`mtconnect-java` is a Java sdk for mtconnect.
+
+### Detail
+It helps users complete the underlying implementation of Java projects that interface with the mtconnect protocol.
+For example, you can use `mtconnect-client` to integrate into Java projects and query information such as Asset and Device through the mtconnect protocol.
+You can also use `mtconnect-server` to interface with PLCs, some IoT cloud service platforms, and other devices to obtain specific device information, and establish a simple and easy-to-use server.
+
+When building a complete, it allows users to customize the implementation of MTProcessor to complete more complex functions.
+The sample 'MTConnectIoTDAServerExample' has the ability to use Huawei Cloud IoT platform to complete the query of device list.