From 620532f32fdefef960718739d1fecb566755ec25 Mon Sep 17 00:00:00 2001 From: Leo <64216877+wangrunlin@users.noreply.github.com> Date: Fri, 15 Jul 2022 20:34:39 +0800 Subject: [PATCH] docs: update README (#5) * Update README * docs: update README --- README.md | 19 +++++++++++++++---- README_zh.md | 19 +++++++++++++++---- 2 files changed, 30 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ed6cf81..fb661df 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,28 @@ # Git Green -[中文](README_zh.md) | [English](README.md) +[中文](README_zh.md) + +## Installation + +downloadable binary form the [releases page][] + +## Precondition + +- Git +- A repository with a clean workspace and upload permissions on the `gh-pages` branch ## How to use ? -1. Download -2. Into your repo path +1. Into your repo path ```shell cd your_repo_path # e.g. # cd git-green ``` -3. run command +2. run command ```shell green ``` + + +[releases page]: https://github.com/wangrunlin/git-green/releases/latest \ No newline at end of file diff --git a/README_zh.md b/README_zh.md index 9f69781..109e0a1 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,17 +1,28 @@ # Git Green -[中文](README_zh.md) | [English](README.md) +[English](README.md) + +## 安装 + +从[发布页面][]下载二进制文件 + +## 前置条件 + +- Git +- 一个工作空间干净并且在 `gh-pages` 分支具有上传权限的存储库 ## 如何使用? -1. 下载 -2. 进入你的存储库路径 +1. 进入你的存储库路径 ```shell cd your_repository_path # 例如: # cd git-green ``` -3. 运行命令 +2. 运行命令 ```shell green ``` + + +[发布页面]: https://github.com/wangrunlin/git-green/releases/latest \ No newline at end of file