Skip to content

Commit c945ff9

Browse files
committed
docs: Update readme
1 parent 7e0ce26 commit c945ff9

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,45 @@
1-
# Cat Code
1+
<p align="center">
2+
<img src="./assets/screenshot.png" alt="Cat Code" width="600px" />
3+
</p>
24

3-
WIP
5+
<p align="center">
6+
<a href="https://www.npmjs.com/package/cat-code">
7+
<img src="https://img.shields.io/npm/v/cat-code" alt="NPM Version" />
8+
</a>
9+
<a href="https://github.com/koki-develop/cat-code/actions/workflows/release-please.yml">
10+
<img src="https://img.shields.io/github/actions/workflow/status/koki-develop/cat-code/release-please.yml" alt="GitHub Actions Workflow Status" />
11+
</a>
12+
<a href="./LICENSE">
13+
<img src="https://img.shields.io/github/license/koki-develop/cat-code" alt="GitHub License" />
14+
</a>
15+
</p>
416

5-
## License
17+
<p align="center">
18+
Cat Code は猫とともに開発ができる次世代のコーディングエージェントです。
19+
</p>
20+
21+
## 使い方
22+
23+
```sh
24+
$ npx cat-code@latest
25+
26+
# セーフモード
27+
$ npx cat-code@latest --safe
28+
```
29+
30+
## 機能
31+
32+
Cat Code にメッセージを送信すると、猫は一定確率でランダムなテキストファイルを書き換えます。
33+
書き換えられるファイルの選択方法は作業ディレクトリの状態によって異なります。
34+
35+
- **git が初期化されているディレクトリの場合**
36+
- git 管理されているテキストファイルをランダムで選択して編集します
37+
- `.gitignore` に設定しているファイルは編集されません
38+
- **git が初期化されていないディレクトリの場合**
39+
- カレントディレクトリ内のテキストファイルをランダムに選択して編集します
40+
41+
セーフモードが有効になっている場合 ( `--safe` フラグ ) はファイルの編集は実行されません。
42+
43+
## ライセンス
644

745
[MIT](./LICENSE)

0 commit comments

Comments
 (0)