Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lxl66566 committed Apr 8, 2024
1 parent 484047f commit b9c3a38
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,29 @@ python3 -m bpm
## Usage

- Install: `bpm i <package>`
- Run `bpm -h` for more help.
- Run `bpm -h` and `bpm i -h` for more help.

```
❯ bpm i -h
usage: bpm install [-h] [-b [BIN_NAME]] [-l [Archive]] [-q] [--one-bin] [--prefer-gnu] [-n] [-i] [--sort [SORT]] packages [packages ...]
positional arguments:
packages Package name or github url to install
options:
-h, --help show this help message and exit
-b [BIN_NAME], --bin-name [BIN_NAME]
specify the binary executable filename, otherwise use package name by default.
-l [Archive], --local [Archive]
install from local archive.
-q, --quiet not ask, install the best match repo.
--one-bin install given binary only. Use package name as binary name by default.
--prefer-gnu bpm prefers musl target by default, you can change this default option.
-n, --dry-run print the install position, but not install actually.
-i, --interactive select asset interactively.
--sort [SORT] sort param in github api, use `best-match` by default. The value could be `stars`, `forks`, `help-wanted-
issues`, `updated`.
```

## How it works

Expand Down Expand Up @@ -98,3 +120,5 @@ poetry run python -m unittest bpm/**/*.py # run tests
- [x] try install
- [x] windows support
- [x] offline install
- [x] install from github link
- [x] update from local
4 changes: 3 additions & 1 deletion docs/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ python3 -m bpm
## 使用

- 安装:`bpm i <package>`
- 执行 `bpm -h` 查看更多帮助。
- 执行 `bpm -h` `bpm i -h`查看更多帮助。

## 原理

Expand Down Expand Up @@ -98,3 +98,5 @@ poetry run python -m unittest bpm/**/*.py # 运行测试
- [x] try install
- [x] windows support
- [x] offline install
- [x] install from github link
- [x] update from local

0 comments on commit b9c3a38

Please sign in to comment.