Skip to content

Commit 4ddb102

Browse files
committed
docs: Update installation instructions and version dependencies
- Added development installation instructions for FastAPI-CacheX in README.md and README.zh-TW.md. - Changed cache key format in both English and Chinese documentation. - Updated author name in pyproject.toml. - Bumped version of ruff to 0.14.10 and ty to 0.0.4 in uv.lock with corresponding source URLs.
1 parent aa724f6 commit 4ddb102

4 files changed

Lines changed: 51 additions & 47 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ A high-performance caching extension for FastAPI, providing comprehensive HTTP c
6363
uv add fastapi-cachex
6464
```
6565

66+
### Development Installation
67+
68+
```bash
69+
uv add git+https://github.com/allen0099/FastAPI-CacheX.git
70+
```
71+
6672
## Quick Start
6773

6874
```python
@@ -106,7 +112,7 @@ FastAPI-CacheX supports multiple caching backends. You can easily switch between
106112
Cache keys are generated in the following format to avoid collisions:
107113

108114
```
109-
{method}:{host}:{path}:{query_params}
115+
{method}|||{host}|||{path}|||{query_params}
110116
```
111117

112118
This ensures that:

‎docs/README.zh-TW.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,14 @@ FastAPI-CacheX 是一個為 FastAPI 框架設計的高效能快取擴充套件
5959

6060
## 安裝指南
6161

62-
### 使用 pip 安裝
63-
6462
```bash
65-
pip install fastapi-cachex
63+
uv pip install fastapi-cachex
6664
```
6765

68-
### 使用 uv 安裝(推薦)
66+
### 開發版本安裝
6967

7068
```bash
71-
uv pip install fastapi-cachex
69+
uv add git+https://github.com/allen0099/FastAPI-CacheX.git
7270
```
7371

7472
## 快速開始
@@ -114,7 +112,7 @@ FastAPI-CacheX 支援多種快取後端。你可以使用 `BackendProxy` 輕鬆
114112
快取金鑰遵循以下格式以避免衝突:
115113

116114
```
117-
{method}:{host}:{path}:{query_params}
115+
{method}|||{host}|||{path}|||{query_params}
118116
```
119117

120118
這確保:

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ readme = "README.md"
66
requires-python = ">=3.10"
77
license = "Apache-2.0"
88
authors = [
9-
{ name = "Allen", email = "s96016641@gmail.com" }
9+
{ name = "allen0099", email = "s96016641@gmail.com" }
1010
]
1111
classifiers = [
1212
"Development Status :: 3 - Alpha",

0 commit comments

Comments
 (0)