From 1ad395febd076694d90d29f4cde52238d03d6270 Mon Sep 17 00:00:00 2001
From: Zhao Xiaojie <LinuxSuRen@gmail.com>
Date: Tue, 23 Jul 2019 20:02:19 +0800
Subject: [PATCH] Add more description into readme file

---
 README-zh.md | 6 +++++-
 README.md    | 6 +++++-
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/README-zh.md b/README-zh.md
index 8f1fbce..82c2547 100644
--- a/README-zh.md
+++ b/README-zh.md
@@ -11,7 +11,7 @@ Jenkins CLI 可以帮忙你轻松地管理 Jenkins。不管你是一名插件开
 * 重启你的 Jenkins
 * 支持通过代理连接
 
-# 开始
+# 安装
 
 我们目前支持的操作系统包括：MacOS、Linux 以及 Widnows。
 
@@ -35,6 +35,10 @@ sudo mv jcli /usr/local/bin/
 
 你只要[点击这里](https://github.com/linuxsuren/jenkins-cli/releases/latest/download/jcli-windows-386.tar.gz)就可以下载到最新版本的压缩包。之后，把解压后的文件 `jcli` 拷贝到你的系统目录下即可。
 
+# 入门
+
+当安装 `jcli` 以后。你需要提供一份配置文件。请执行命令 `jcli config -g`，并把输出的内容拷贝到文件 `~/.jenkins-cli.yaml` 中，并根据你的 Jenkins 配置做相应的修改。
+
 # 贡献
 
 该工具还处在非常早期的开发阶段，我们欢迎任何形式的贡献。
diff --git a/README.md b/README.md
index 4e803dd..49fffd0 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ developer, administrator or just a regular user, it borns for you!
 * Restart your Jenkins
 * Connection with proxy support
 
-# Get started
+# Get it
 
 We support mac, linux and windows for now.
 
@@ -36,6 +36,10 @@ sudo mv jcli /usr/local/bin/
 
 You can find the latest version by [click here](https://github.com/linuxsuren/jenkins-cli/releases/latest/download/jcli-windows-386.tar.gz). Then download the tar file, cp the uncompressed `jcli` directory into your system path.
 
+# Get started
+
+Once you'v installed `jcli`. You should provide a config for it. Please execute cmd `jcli config -g`, then copy the output into `~/.jenkins-cli.yaml`. According to your Jenkins configuration to modify this file.
+
 # Contribution
 
 It's still under very early develope time. Any contribution is welcome.
-- 
GitLab