Skip to content

Commit 4c10d86

Browse files
committed
docs(readme): add upgrade instructions for 0.3.x to 0.4.x
1 parent 42095f4 commit 4c10d86

6 files changed

Lines changed: 92 additions & 5 deletions

File tree

README.ja.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,23 @@ cccc
6969
>
7070
> エラーが発生した場合は、診断と解決を手伝ってください。
7171
72+
### 旧バージョンからのアップグレード
73+
74+
古いバージョンの cccc-pair(例:0.3.x)がインストールされている場合は、先にアンインストールが必要です:
75+
76+
```bash
77+
# pipx ユーザー
78+
pipx uninstall cccc-pair
79+
80+
# pip ユーザー
81+
pip uninstall cccc-pair
82+
83+
# 残留ファイルがある場合は手動で削除
84+
rm -f ~/.local/bin/cccc ~/.local/bin/ccccd
85+
```
86+
87+
> **注意**:0.4.x のコマンド構造は 0.3.x と完全に異なります。旧版の `init``run``bridge` コマンドは `attach``daemon``mcp` などに置き換えられました。
88+
7289
### TestPyPI からインストール(推奨)
7390

7491
```bash

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,23 @@ Copy this prompt to your AI assistant (Claude, ChatGPT, etc.):
6969
>
7070
> If you encounter any errors, please help me diagnose and resolve them.
7171
72+
### Upgrading from older versions
73+
74+
If you have an older version of cccc-pair installed (e.g., 0.3.x), you must uninstall it first:
75+
76+
```bash
77+
# For pipx users
78+
pipx uninstall cccc-pair
79+
80+
# For pip users
81+
pip uninstall cccc-pair
82+
83+
# Remove any leftover binaries if needed
84+
rm -f ~/.local/bin/cccc ~/.local/bin/ccccd
85+
```
86+
87+
> **Note**: Version 0.4.x has a completely different command structure from 0.3.x. The old `init`, `run`, `bridge` commands are replaced with `attach`, `daemon`, `mcp`, etc.
88+
7289
### From TestPyPI (recommended)
7390

7491
```bash

README.zh-CN.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,23 @@ cccc
6969
>
7070
> 如果遇到任何错误,请帮我诊断并解决。
7171
72+
### 从旧版本升级
73+
74+
如果你已安装旧版本的 cccc-pair(如 0.3.x),必须先卸载:
75+
76+
```bash
77+
# pipx 用户
78+
pipx uninstall cccc-pair
79+
80+
# pip 用户
81+
pip uninstall cccc-pair
82+
83+
# 如有残留,手动删除
84+
rm -f ~/.local/bin/cccc ~/.local/bin/ccccd
85+
```
86+
87+
> **注意**:0.4.x 版本的命令结构与 0.3.x 完全不同。旧版的 `init``run``bridge` 命令已被 `attach``daemon``mcp` 等替代。
88+
7289
### 从 TestPyPI 安装(推荐)
7390

7491
```bash

docs/guide/faq.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,31 @@ Frequently asked questions about CCCC.
1010
# From TestPyPI (RC version)
1111
python -m pip install --index-url https://pypi.org/simple \
1212
--extra-index-url https://test.pypi.org/simple \
13-
cccc-pair==0.4.0rc16
13+
cccc-pair==0.4.0rc17
1414

1515
# From source
16-
git clone https://github.com/ChesterRa/cccc
16+
git clone https://github.com/dweb-channel/cccc
1717
cd cccc
1818
pip install -e .
1919
```
2020

21+
### How do I upgrade from an older version (0.3.x)?
22+
23+
You must uninstall the old version first:
24+
25+
```bash
26+
# For pipx users
27+
pipx uninstall cccc-pair
28+
29+
# For pip users
30+
pip uninstall cccc-pair
31+
32+
# Remove any leftover binaries
33+
rm -f ~/.local/bin/cccc ~/.local/bin/ccccd
34+
```
35+
36+
Then install the new version. Note that 0.4.x has a completely different command structure from 0.3.x.
37+
2138
### What are the system requirements?
2239

2340
- Python 3.9+

docs/guide/getting-started/index.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,37 @@ Both approaches require:
4141

4242
## Installation
4343

44+
### Upgrading from older versions
45+
46+
If you have an older version of cccc-pair installed (e.g., 0.3.x), you must uninstall it first:
47+
48+
```bash
49+
# For pipx users
50+
pipx uninstall cccc-pair
51+
52+
# For pip users
53+
pip uninstall cccc-pair
54+
55+
# Remove any leftover binaries if needed
56+
rm -f ~/.local/bin/cccc ~/.local/bin/ccccd
57+
```
58+
59+
::: warning Version 0.4.x Breaking Changes
60+
Version 0.4.x has a completely different command structure from 0.3.x. The old `init`, `run`, `bridge` commands are replaced with `attach`, `daemon`, `mcp`, etc.
61+
:::
62+
4463
### From TestPyPI (recommended for RC)
4564

4665
```bash
4766
python -m pip install --index-url https://pypi.org/simple \
4867
--extra-index-url https://test.pypi.org/simple \
49-
cccc-pair==0.4.0rc16
68+
cccc-pair==0.4.0rc17
5069
```
5170

5271
### From Source
5372

5473
```bash
55-
git clone https://github.com/ChesterRa/cccc
74+
git clone https://github.com/dweb-channel/cccc
5675
cd cccc
5776
pip install -e .
5877
```

docs/vnext/RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ The release workflow is tag-driven (`v*`) and enforces that the git tag matches
4040
```bash
4141
python -m pip install --index-url https://pypi.org/simple \
4242
--extra-index-url https://test.pypi.org/simple \
43-
cccc-pair==0.4.0rc16
43+
cccc-pair==0.4.0rc17
4444
```

0 commit comments

Comments
 (0)