From 78391369a4f65fa3b200e5f9f96eee97ccfd2283 Mon Sep 17 00:00:00 2001 From: hengyunabc Date: Thu, 29 Nov 2018 16:33:17 +0800 Subject: [PATCH] update README --- README.md | 30 ++++++++++++--------- README_CN.md | 32 +++++++++++++++-------- site/src/site/sphinx/en/install-detail.md | 2 +- site/src/site/sphinx/install-detail.md | 2 +- 4 files changed, 41 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 1a6a341fdf9..7f718a3f527 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Arthas help developers in trouble-shooting production issues for Java applications without modifying code or restarting servers. -[中文说明](README_CN.md) (For Chinese Documentation) +[中文说明/Chinese Documentation](README_CN.md) ### Background @@ -41,26 +41,32 @@ Arthas was built to solve these issues. A developer can trouble-shoot your produ ### Quick start -#### Linux/Unix/Mac +#### Use `arthas-boot`(Recommend) -Install Arthas: +Download`arthas-boot.jar`,Start with `java` command: -``` -curl -L https://alibaba.github.io/arthas/install.sh | sh +```bash +wget https://alibaba.github.io/arthas/arthas-boot.jar +java -jar arthas-boot.jar ``` -Start Arthas: +Print usage: +```bash +java -jar arthas-boot.jar -h ``` -./as.sh + +#### Use `as.sh` + +You can install Arthas with one single line command on Linux, Unix, and Mac. Pls. copy the following command and paste it into the command line, then press *Enter* to run: + +```bash +curl -L https://alibaba.github.io/arthas/install.sh | sh ``` -#### Windows +The command above will download the bootstrap script `as.sh` to the current directory. You can move it the any other place you want, or put its location in `$PATH`. -1. Click [![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=bin&v=LATEST) to download the latest binary releases of `bin.zip`. -2. Unzip the file. -3. Go to the bin directory -4. Run the following command `as.bat $PID` +You can enter its interactive interface by executing `as.sh`, or execute `as.sh -h` for more help information. ### Documentation diff --git a/README_CN.md b/README_CN.md index 3b1caeb16b5..2f5f1dd5a18 100644 --- a/README_CN.md +++ b/README_CN.md @@ -31,26 +31,36 @@ English version goes [here](README.md). ### 快速开始 -#### Linux/Unix/Mac +#### 使用`arthas-boot`(推荐) -安装Arthas: +下载`arthas-boot.jar`,然后用`java -jar`的方式启动: -``` -curl -L https://alibaba.github.io/arthas/install.sh | sh +```bash +wget https://alibaba.github.io/arthas/arthas-boot.jar +java -jar arthas-boot.jar ``` -启动Arthas: +打印帮助信息: +```bash +java -jar arthas-boot.jar -h ``` -./as.sh + +* 如果下载速度比较慢,可以使用aliyun的镜像:`java -jar arthas-boot.jar --repo-mirror aliyun --use-http` + +#### 使用`as.sh` + +Arthas 支持在 Linux/Unix/Mac 等平台上一键安装,请复制以下内容,并粘贴到命令行中,敲 `回车` 执行即可: + +```bash +curl -L https://alibaba.github.io/arthas/install.sh | sh ``` -#### Windows +上述命令会下载启动脚本文件 `as.sh` 到当前目录,你可以放在任何地方或将其加入到 `$PATH` 中。 + +直接在shell下面执行`./as.sh`,就会进入交互界面。 -1. 点击 [![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=bin&v=LATEST) 下载最新的Arthas `bin.zip`包 -2. 解压缩zip包. -3. 进入bin目录 -4. 执行以下命令 `as.bat $PID` +也可以执行`./as.sh -h`来获取更多参数信息。 ### 文档 diff --git a/site/src/site/sphinx/en/install-detail.md b/site/src/site/sphinx/en/install-detail.md index f47f5f12455..0b30078c632 100644 --- a/site/src/site/sphinx/en/install-detail.md +++ b/site/src/site/sphinx/en/install-detail.md @@ -4,7 +4,7 @@ Install Arthas ## Quick installation -### Use `arthas-boot` +### Use `arthas-boot`(Recommend) Download`arthas-boot.jar`,Start with `java` command: diff --git a/site/src/site/sphinx/install-detail.md b/site/src/site/sphinx/install-detail.md index b063491881e..646cdbbce56 100644 --- a/site/src/site/sphinx/install-detail.md +++ b/site/src/site/sphinx/install-detail.md @@ -3,7 +3,7 @@ Arthas Install ## 快速安装 -### 使用`arthas-boot` +### 使用`arthas-boot`(推荐) 下载`arthas-boot.jar`,然后用`java -jar`的方式启动: