Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiandongx committed Jun 16, 2021
1 parent 4ff6f68 commit c2c1f1d
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@
### Installation

* 使用 `go get` 安装
```shell
$ go get -u github.com/chenjiandongx/pls
```
#### 1) 使用 `go get` 安装

* 使用编译好的二进制版本: [releases](https://github.com/chenjiandongx/pls/releases)
```shell
$ go get -u github.com/chenjiandongx/pls
```

#### 2) 使用编译好的二进制版本

https://github.com/chenjiandongx/pls/releases

### Usages

Expand All @@ -34,16 +37,21 @@ Flags:
Use "pls [command] --help" for more information about a command.
```

### Examples
建议第一次使用的时候先初始化所有命令
```shell
$ 🐶 pls upgrade
```

配置文件位于 `~/.commands/config/json` 可以更改命令文件下载目录

> Note: 建议第一次使用的时候先初始化所有命令,可以使用 -d 指定命令文档文件夹下载位置
```shell
$ pls upgrade
❯ 🐶 cat ~/.commands/config.json
{"dir":"/Users/chenjiandongx/.commands"}
```

> Tip: 可以将输出结果传入到 less 管道
可以将输出结果传入到 less 管道
```shell
$ pls show curl | less
$ 🐶 pls show curl | less
```

效果图
Expand Down

0 comments on commit c2c1f1d

Please sign in to comment.