From b5c1afe0f388dd2a651cec73000709d0bc703131 Mon Sep 17 00:00:00 2001
From: Denghui Dong <denghui.ddh@alibaba-inc.com>
Date: Fri, 13 Oct 2023 17:27:28 +0800
Subject: [PATCH] docs: add README

---
 README.md                          | 22 +++++++++++++++-
 README_zh.md                       | 42 ++++++++++++++++++++++++++++++
 site/docs/.vitepress/config.mts    |  2 +-
 site/docs/guide/contributing.md    |  2 +-
 site/docs/index.md                 |  2 +-
 site/docs/zh/guide/contributing.md |  2 +-
 6 files changed, 67 insertions(+), 5 deletions(-)
 create mode 100644 README_zh.md

diff --git a/README.md b/README.md
index 11a50ffd..374ebbe7 100644
--- a/README.md
+++ b/README.md
@@ -14,4 +14,24 @@
 [![Eclipse License](https://img.shields.io/github/license/eclipse/jifa?label=License)](https://github.com/eclipse/jifa/blob/main/LICENSE)
 ![Commit Check](https://github.com/eclipse/jifa/actions/workflows/commit-check.yml/badge.svg?branch=main)
 
-TODO
\ No newline at end of file
+- [中文](README_zh.md)
+
+> An open-source project for diagnosing common Java issues.
+>
+> Latest Version: 0.2.0-SNAPSHOT
+>
+> Complete information is available in the documentation at [https://eclipse.github.io/jifa](https://eclipse.github.io/jifa). Please refer to it for details.
+
+## Quick Start
+
+### Run Jifa Locally with a Single Command
+
+```shell
+# Please make sure that Docker is installed.
+$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/eclipse/jifa/HEAD/scripts/jifa.sh)"
+```
+
+## Links
+- [GitHub Pages](https://eclipse.github.io/jifa)
+- [Mail List](https://accounts.eclipse.org/mailing-list/jifa-dev)
+- [Slack Channel](https://eclipsejifa.slack.com/)
diff --git a/README_zh.md b/README_zh.md
new file mode 100644
index 00000000..fdc1112f
--- /dev/null
+++ b/README_zh.md
@@ -0,0 +1,42 @@
+<!--
+    Copyright (c) 2020, 2023 Contributors to the Eclipse Foundation
+
+    See the NOTICE file(s) distributed with this work for additional
+    information regarding copyright ownership.
+
+    This program and the accompanying materials are made available under the
+    terms of the Eclipse Public License 2.0 which is available at
+    http://www.eclipse.org/legal/epl-2.0
+
+    SPDX-License-Identifier: EPL-2.0
+ -->
+# Eclipse Jifa
+[![Eclipse License](https://img.shields.io/github/license/eclipse/jifa?label=License)](https://github.com/eclipse/jifa/blob/main/LICENSE)
+![Commit Check](https://github.com/eclipse/jifa/actions/workflows/commit-check.yml/badge.svg?branch=main)
+
+- [English](README.md)
+
+> 一个致力于帮助 Java 研发人员排查应用中常见问题的开源项目。
+>
+> 最新版本：0.2.0-SNAPSHOT
+>
+> 更多的项目信息请访问 [https://eclipse.github.io/jifa](https://eclipse.github.io/jifa)。
+
+## 快速开始
+
+### 一个命令运行 Jifa
+
+```shell
+# 本地环境需要安装 docker
+$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/eclipse/jifa/HEAD/scripts/jifa.sh)"
+```
+
+## 相关链接
+
+- [GitHub Pages](https://eclipse.github.io/jifa)
+- [邮件列表](https://accounts.eclipse.org/mailing-list/jifa-dev)
+- 钉钉交流群二维码
+
+  <div>
+    <img src=https://user-images.githubusercontent.com/33491035/226314386-e1cf71d4-8429-4e4c-bdc0-c511a9009ee1.JPG alt="DingTalk" width=35%/>
+  </div>
\ No newline at end of file
diff --git a/site/docs/.vitepress/config.mts b/site/docs/.vitepress/config.mts
index 328aa692..c22c9292 100644
--- a/site/docs/.vitepress/config.mts
+++ b/site/docs/.vitepress/config.mts
@@ -5,7 +5,7 @@ export default defineConfig({
 
   title: "Eclipse Jifa",
   titleTemplate: ":title · Eclipse Jifa",
-  description: "An open source project for diagnosing common Java issues.",
+  description: "An open-source project for diagnosing common Java issues.",
 
   lastUpdated: true,
 
diff --git a/site/docs/guide/contributing.md b/site/docs/guide/contributing.md
index e0ec8bcb..f8a36736 100644
--- a/site/docs/guide/contributing.md
+++ b/site/docs/guide/contributing.md
@@ -28,7 +28,7 @@ Prior to submitting a pull request, please ensure your code is well-formatted:
 
 ## Contributors
 
-Thanks to the following programmers for their contributions to the Jifa project.
+Thank you to all the people who already contributed to Jifa!
 
 <a href="https://github.com/eclipse/jifa/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=eclipse/jifa" alt="Contributors"/>
diff --git a/site/docs/index.md b/site/docs/index.md
index f891ddfc..e6488130 100644
--- a/site/docs/index.md
+++ b/site/docs/index.md
@@ -5,7 +5,7 @@ layout: home
 
 hero:
   name: "Eclipse Jifa"
-  tagline: "An open source project for diagnosing common Java issues"
+  tagline: "An open-source project for diagnosing common Java issues"
   actions:
     - theme: brand
       text: Get Started
diff --git a/site/docs/zh/guide/contributing.md b/site/docs/zh/guide/contributing.md
index 197687ba..3debf331 100644
--- a/site/docs/zh/guide/contributing.md
+++ b/site/docs/zh/guide/contributing.md
@@ -28,7 +28,7 @@
 
 ## 贡献者
 
-感谢以下开发者为 Jifa 项目所作出的贡献。
+感谢所有为 Jifa 项目做出贡献的开发者们！
 
 <a href="https://github.com/eclipse/jifa/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=eclipse/jifa" alt="Contributors"/>