Skip to content

Commit

Permalink
docs(README): supplementary reliance requirements #11
Browse files Browse the repository at this point in the history
  • Loading branch information
real-LiHua committed Oct 30, 2024
1 parent 3e14d79 commit 2ce59c4
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 30 deletions.
61 changes: 31 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
# Batch keybox checker

## Requirements
Python >= 3.8
For restricted network environments, it may be necessary to set the web proxy environment variables: `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`. (See: [Requests documentation](https://requests.readthedocs.io/en/latest/user/advanced/#proxies) for details)

## Install
```bash
pip install keyboxchecker
```

## Usage
```bash
usage: keyboxchecker [-h] [-a] [-o OUTPUT] [-p PATH]

options:
-h, --help show this help message and exit
-a, --aosp Categorizes the AOSP keybox as "Survivor" with a default value of "False"
-o OUTPUT, --output OUTPUT
Resulting output directory, defaults to current Directory
-p PATH, --path PATH Directory where keybox is located, defaults to current directory
```

## Uninstall
```bash
pip uninstall keyboxchecker
```

## Credits
[KimmyXYC/KeyboxChecker](https://github.com/KimmyXYC/KeyboxChecker)
# Batch keybox checker

## Requirements
Rust (Compile-Time)
Python >= 3.8
For restricted network environments, it may be necessary to set the web proxy environment variables: `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`. (See: [Requests documentation](https://requests.readthedocs.io/en/latest/user/advanced/#proxies) for details)

## Install
```bash
pip install keyboxchecker
```

## Usage
```bash
usage: keyboxchecker [-h] [-a] [-o OUTPUT] [-p PATH]

options:
-h, --help show this help message and exit
-a, --aosp Categorizes the AOSP keybox as "Survivor" with a default value of "False"
-o OUTPUT, --output OUTPUT
Resulting output directory, defaults to current Directory
-p PATH, --path PATH Directory where keybox is located, defaults to current directory
```

## Uninstall
```bash
pip uninstall keyboxchecker
```

## Credits
[KimmyXYC/KeyboxChecker](https://github.com/KimmyXYC/KeyboxChecker)
1 change: 1 addition & 0 deletions docs/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# 批量密钥箱检测器

## 要求
Rust (编译时需要)
Python >= 3.8
连接国际互联网,网络代理环境变量:`HTTP_PROXY``HTTPS_PROXY``ALL_PROXY`。(详见:[Requests 官方文档](https://requests.readthedocs.io/projects/cn/zh-cn/latest/user/advanced.html#proxies)

Expand Down

0 comments on commit 2ce59c4

Please sign in to comment.