From 5cb1b2aad91a60965ea8c68e45ec6d137243eb98 Mon Sep 17 00:00:00 2001
From: kumudiaorong <kmdr.error@gmail.com>
Date: Fri, 1 Mar 2024 23:35:56 +0800
Subject: [PATCH] feat:add readme info

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 04a749d..74fbbd8 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,28 @@
-# qst-ext-appsearcher-rust
\ No newline at end of file
+# qst-ext-appsearcher-rust
+
+## Introduction
+This is a extension for the [qst](https://github.com/kumudiaorong/qst-grpc) written in rust. It is used to search the application in the system.
+
+## Getting Started
+
+### Get Release
+
+No release yet.
+
+### Build from source
+
+#### Dependencies
+First please install [rust](https://www.rust-lang.org/tools/install).
+
+Then see [tonic](https://github.com/hyperium/tonic) for other dependencies.
+
+#### Get Source
+```shell
+git clone https://github.com/kumudiaorong/qst-ext-appsearcher-rust.git
+git submodule update --init
+```
+
+#### Build
+```shell
+cargo build --release
+```
\ No newline at end of file