Skip to content

Commit

Permalink
docs: update README (#5)
Browse files Browse the repository at this point in the history
* Update README

* docs: update README
  • Loading branch information
wangrunlin authored Jul 15, 2022
1 parent 2e7e5b2 commit 620532f
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
19 changes: 15 additions & 4 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 620532f

Please sign in to comment.