update: readme add pip install (#9)

TencentBlueKing · Nov 9, 2024 · 72b17a0 · 72b17a0
1 parent 74d9af9
commit 72b17a0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -15,6 +15,14 @@ bscp-python-sdk 是蓝鲸 BSCP 项目的 Python SDK，它能帮助你轻松访
 
 ## 使用示例
 
+### 安装
+
+```bash
+python -m pip install bk-bscp
+```
+
+注: 只支持 `Python 3.8+` 版本
+
 ### 客户端对象 `BscpClient`
 
 使用 `BscpClient` 来完成主要操作，其支持两种不同的调用风格。

diff --git a/readme_en.md b/readme_en.md
@@ -15,6 +15,14 @@ bscp-python-sdk is the Python SDK of the Blue Whale BSCP project. It can help yo
 
 ## Quick Start
 
+### Installation
+
+```bash
+python -m pip install bk-bscp
+```
+
+Tip: Only `Python 3.8+` is supported
+
 ### client object`BscpClient`
 
 Use `BscpClient` to complete the main operations, which supports two different calling styles.