Skip to content

Commit f879600

Browse files
authored
Merge pull request #9 from inaniwaudon/inaniwaudon/fix-readme-20250322
README を修正
2 parents 0ad00ab + 5ba743b commit f879600

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@
5050
},
5151
"defaultMode" : "デフォルトでの実行設定。llm または sh",
5252
"llm" : {
53-
"model" : "OpenAI のモデル",
53+
"model" : "LLM のモデル",
5454
"systemPrompt" : "システムプロンプト",
55-
"apiKey" : "OpenAI の API キー"
55+
"apiKey" : "API キー",
56+
"provider" : "LLM のプラットフォーム。openai または openrouter(任意、既定値は openai)"
5657
},
5758
"width" : ウィンドウの幅,
5859
"shortcut" : {
@@ -61,6 +62,13 @@
6162
}
6263
```
6364

65+
#### LLM の指定
66+
LLM には [OpenAI API](https://openai.com/index/openai-api/) を直接使用するか、または [OpenRouter](https://openrouter.ai/) を使用することができます。この挙動は `llm.provider` の値に応じて変化します。
67+
68+
- OpenAI API を使用する場合、`llm.model` にはモデル名を直接指定(例:`gpt-4o`)するか、または `openai/gpt-4o` のように指定します。
69+
- `openrouter` の場合は、`google/gemini-2.0-flash-001` のように指定します。
70+
71+
#### ショートカット
6472
`shortcut` に辞書形式でショートカットを登録すると、よく使う入力文を簡単に呼び出すことが可能となります。
6573

6674
- ショートカットの内容には、プロンプトおよびシェルコマンドの両方を記述できます。
@@ -93,4 +101,4 @@ Can you review it again?
93101

94102
## ライセンス
95103

96-
Copyright (c) 2024 いなにわうどん. This application is released under the MIT License, see [LICENSE](https://github.com/inaniwaudon/clipshort/blob/main/LICENSE).
104+
Copyright (c) 2025 いなにわうどん. This application is released under the MIT License, see [LICENSE](https://github.com/inaniwaudon/clipshort/blob/main/LICENSE).

0 commit comments

Comments
 (0)