Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
D-D-H committed Oct 13, 2023
1 parent b5c1afe commit db2f811
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 18 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,30 @@
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)

- [中文](README_zh.md)
> [中文](README_zh.md)
## Introduction

Eclipse Jifa is an open-source project for diagnosing common Java issues.

> 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.
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)"
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/eclipse/jifa/HEAD/scripts/jifa.sh)"
```

Note: Please make sure that Docker is installed.

## Links
- [GitHub Pages](https://eclipse.github.io/jifa)
- [Mail List](https://accounts.eclipse.org/mailing-list/jifa-dev)
Expand Down
24 changes: 14 additions & 10 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,33 @@
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)
> [English](README.md)
## 简介

Eclipse Jifa 是一个致力于帮助 Java 研发人员排查应用中常见问题的开源项目。

> 一个致力于帮助 Java 研发人员排查应用中常见问题的开源项目。
>
> 最新版本:0.2.0-SNAPSHOT
>
> 更多的项目信息请访问 [https://eclipse.github.io/jifa](https://eclipse.github.io/jifa)
最新版本:0.2.0-SNAPSHOT

## 快速开始
关于项目的更多信息请访问 [https://eclipse.github.io/jifa](https://eclipse.github.io/jifa/zh/)

## 快速上手

### 一个命令运行 Jifa

```shell
# 本地环境需要安装 docker
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/eclipse/jifa/HEAD/scripts/jifa.sh)"
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/eclipse/jifa/HEAD/scripts/jifa.sh)"
```

注:本地环境需要安装 docker

## 相关链接

- [GitHub Pages](https://eclipse.github.io/jifa)
- [GitHub Pages](https://eclipse.github.io/jifa/zh/)
- [邮件列表](https://accounts.eclipse.org/mailing-list/jifa-dev)
- 钉钉交流群二维码

Expand Down

0 comments on commit db2f811

Please sign in to comment.