Skip to content

Commit 83a2c4e

Browse files
committed
Provider a better readme file
1 parent d2d6c89 commit 83a2c4e

File tree

2 files changed

+36
-5
lines changed

2 files changed

+36
-5
lines changed

README-zh.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[![](https://goreportcard.com/badge/linuxsuren/http-downloader)](https://goreportcard.com/report/linuxsuren/github-go)
2+
[![](http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://godoc.org/github.com/linuxsuren/http-downloader)
3+
[![Contributors](https://img.shields.io/github/contributors/linuxsuren/http-downloader.svg)](https://github.com/linuxsuren/github-go/graphs/contributors)
4+
[![GitHub release](https://img.shields.io/github/release/linuxsuren/http-downloader.svg?label=release)](https://github.com/linuxsuren/github-go/releases/latest)
5+
![GitHub All Releases](https://img.shields.io/github/downloads/linuxsuren/http-downloader/total)
6+
7+
# 入门
8+
9+
`hd` 是一个基于 HTTP 协议的下载工具。
10+
11+
通过命令:`brew install linuxsuren/linuxsuren/hd` 来安装
12+
13+
# 用法
14+
15+
```
16+
hd https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-linux-amd64.tar.gz -o jcli.tar.gz --thread 10
17+
```
18+
19+
# 功能
20+
21+
* 基于 HTTP 协议下载文件的 Golang 工具库
22+
* 多线程
23+
* 断点续传 (TODO)
24+
* 对 GitHub release 文件下载友好 (TODO)

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,19 @@
66

77
# Get started
88

9-
You can use this template repository via the following command:
9+
`hd` is a HTTP download tool.
1010

11-
`gh repo create --public -p linuxsuren/http-downloader -y <project-name>`
11+
Install it via: `brew install linuxsuren/linuxsuren/hd`
1212

13-
# Clean
13+
# Usage
1414

15-
Please run the following command, after you created your project base on this template repository:
15+
```
16+
hd https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-linux-amd64.tar.gz -o jcli.tar.gz --thread 10
17+
```
1618

17-
`./hack/init.sh <project-name>`
19+
# Features
20+
21+
* go library for HTTP
22+
* multi-thread
23+
* continuously (TODO)
24+
* GitHub release asset friendly (TODO)

0 commit comments

Comments
 (0)