Skip to content

Commit 139c64f

Browse files
committed
Update README files for improved formatting and consistency
- Added spacing for better readability in both `README_CN.rst` and `README.rst`. - Ensured consistent formatting of environment variable setup instructions. - Clarified the recommendation for using a `.env` file to secure API keys.
1 parent 2a1e90f commit 139c64f

File tree

2 files changed

+35
-30
lines changed

2 files changed

+35
-30
lines changed

docs/source/README.rst

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,25 @@ Configuration
2929
The SDK uses environment variables for configuration. You can set these up in two ways:
3030

3131
1. Using a `.env` file (recommended):
32-
.. code-block:: bash
33-
34-
# Create a .env file in your project root
35-
BT_API_KEY="your-api-key"
36-
BT_PANEL_HOST="http://localhost:8888"
37-
DEBUG=False
38-
TIMEOUT=30
39-
VERIFY_SSL=False
40-
41-
2. Setting environment variables directly:
42-
.. code-block:: bash
43-
44-
export BT_API_KEY="your-api-key"
45-
export BT_PANEL_HOST="http://localhost:8888"
46-
export DEBUG=False
47-
export TIMEOUT=30
48-
export VERIFY_SSL=False
32+
33+
.. code-block:: bash
34+
35+
# Create a .env file in your project root
36+
BT_API_KEY="your-api-key"
37+
BT_PANEL_HOST="http://localhost:8888"
38+
DEBUG=False
39+
TIMEOUT=30
40+
VERIFY_SSL=False
41+
42+
1. Setting environment variables directly:
43+
44+
.. code-block:: bash
45+
46+
export BT_API_KEY="your-api-key"
47+
export BT_PANEL_HOST="http://localhost:8888"
48+
export DEBUG=False
49+
export TIMEOUT=30
50+
export VERIFY_SSL=False
4951
5052
> Note: The `.env` file should be added to your `.gitignore` to keep your API key secure.
5153

docs/source/README_CN.rst

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
安装
1313
========
14+
1415
.. code-block:: bash
1516
1617
pip install bt-python-sdk
@@ -27,23 +28,25 @@
2728
SDK 使用环境变量进行配置。您可以通过以下两种方式设置:
2829

2930
1. 使用 `.env` 文件(推荐):
30-
.. code-block:: bash
3131

32-
# 在项目根目录创建 .env 文件
33-
BT_API_KEY="your-api-key"
34-
BT_PANEL_HOST="http://localhost:8888"
35-
DEBUG=False
36-
TIMEOUT=30
37-
VERIFY_SSL=False
32+
.. code-block:: bash
33+
34+
# 在项目根目录创建 .env 文件
35+
BT_API_KEY="your-api-key"
36+
BT_PANEL_HOST="http://localhost:8888"
37+
DEBUG=False
38+
TIMEOUT=30
39+
VERIFY_SSL=False
3840
3941
2. 直接设置环境变量:
40-
.. code-block:: bash
4142

42-
export BT_API_KEY="your-api-key"
43-
export BT_PANEL_HOST="http://localhost:8888"
44-
export DEBUG=False
45-
export TIMEOUT=30
46-
export VERIFY_SSL=False
43+
.. code-block:: bash
44+
45+
export BT_API_KEY="your-api-key"
46+
export BT_PANEL_HOST="http://localhost:8888"
47+
export DEBUG=False
48+
export TIMEOUT=30
49+
export VERIFY_SSL=False
4750
4851
> 注意:`.env` 文件应该添加到 `.gitignore` 中,以保护您的 API 密钥安全。
4952

0 commit comments

Comments
 (0)