Skip to content

Commit 23e428d

Browse files
massongitclaude
andauthored
Add npx usage instructions to README files (#36)
Restructure README to prioritize end-user experience: - Add npx execution examples for general users (no installation) - Move build/development instructions to "For Developers" section - Simplify usage documentation for better clarity Both English and Japanese READMEs updated for consistency. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Sonnet 4.5 <[email protected]>
1 parent 99cebed commit 23e428d

File tree

2 files changed

+46
-48
lines changed

2 files changed

+46
-48
lines changed

README.ja.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,13 @@ Claude Codeでは、特定のコマンド実行を今後ユーザーへの確認
3131

3232
## 使い方
3333

34-
### 1. ビルド
34+
npxで直接実行できます(インストール不要)。
3535

3636
```bash
37-
bun run build
38-
```
39-
40-
### 2. 実行
41-
42-
開発時(TypeScriptを直接実行)。
37+
npx merge-claude-code-settings
4338

44-
```bash
45-
bun run dev
46-
```
47-
48-
ビルド後(コンパイル済みJavaScriptを実行)。
49-
50-
```bash
51-
node dist/index.js
39+
# デバッグモード(各プロジェクトで許可されているコマンドを標準出力)
40+
npx merge-claude-code-settings --show-allow-commands
5241
```
5342

5443
実行すると次の処理を行います。
@@ -59,15 +48,7 @@ node dist/index.js
5948
4. 現在の設定のバックアップを作成 (`~/.claude/settings.json.bak`)
6049
5. マージ済み設定を `~/.claude/settings.json` に書き込み
6150

62-
### デバッグモード
63-
64-
`--show-allow-commands` オプションを付与すると、各プロジェクトで許可されているコマンドを標準出力します。
65-
66-
```bash
67-
node dist/index.js --show-allow-commands
68-
```
69-
70-
出力例。
51+
`--show-allow-commands` オプション使用時の出力例。
7152

7253
<!-- markdownlint-disable MD010 -->
7354

@@ -107,6 +88,24 @@ node dist/index.js --show-allow-commands
10788

10889
## 開発
10990

91+
### 開発者向け
92+
93+
ソースからビルドして実行。
94+
95+
```bash
96+
# TypeScript を JavaScript にビルド
97+
bun run build
98+
99+
# Bun で直接実行(開発モード)
100+
bun run dev
101+
102+
# コンパイル済み JavaScript を実行
103+
node dist/index.js
104+
105+
# デバッグモード
106+
node dist/index.js --show-allow-commands
107+
```
108+
110109
### 設定
111110

112111
<https://pre-commit.com/> の手順に従って `pre-commit` をインストールします。

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,13 @@ This enables common permissions across all projects.
2727

2828
## Usage
2929

30-
### 1. Build
30+
Run directly with npx (no installation required).
3131

3232
```bash
33-
bun run build
34-
```
35-
36-
### 2. Run
37-
38-
Development mode (run TypeScript directly).
33+
npx merge-claude-code-settings
3934

40-
```bash
41-
bun run dev
42-
```
43-
44-
Production mode (run compiled JavaScript).
45-
46-
```bash
47-
node dist/index.js
35+
# Debug mode (print allowed commands to stdout)
36+
npx merge-claude-code-settings --show-allow-commands
4837
```
4938

5039
The following operations are performed.
@@ -55,15 +44,7 @@ The following operations are performed.
5544
4. Creates a backup of the current settings (`~/.claude/settings.json.bak`)
5645
5. Writes the merged settings to `~/.claude/settings.json`
5746

58-
### Debug Mode
59-
60-
Use the `--show-allow-commands` option to print allowed commands to stdout.
61-
62-
```bash
63-
node dist/index.js --show-allow-commands
64-
```
65-
66-
Example output.
47+
Example output with `--show-allow-commands` option.
6748

6849
<!-- markdownlint-disable MD010 -->
6950

@@ -103,6 +84,24 @@ Special handling is applied.
10384

10485
## Development
10586

87+
### For Developers
88+
89+
Build and run from source.
90+
91+
```bash
92+
# Build TypeScript to JavaScript
93+
bun run build
94+
95+
# Run directly with Bun (development mode)
96+
bun run dev
97+
98+
# Run compiled JavaScript
99+
node dist/index.js
100+
101+
# Debug mode
102+
node dist/index.js --show-allow-commands
103+
```
104+
106105
### Setup
107106

108107
Install `pre-commit` by following the instructions at <https://pre-commit.com/>.

0 commit comments

Comments
 (0)