Update README.md

README.md

@@ -10,4 +10,55 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# itako
+
+itakoは、Anthropic APIを利用したロールプレイチャットボットアプリケーションです。ユーザーが指定した役割、口調、発話例、制約条件に基づいて、アシスタントがロールプレイを行います。
+
+## 必要条件
+
+- Python 3.x
+- Gradio
+- Anthropic API
+- AnthropicのAPIkeyが必要です
+
+## セットアップ
+
+1. パッケージをインストールします
+
+```
+!pip install anthropic==0.23.1
+!pip install gradio==4.25.0
+```
+
+2. [コードはこちら](https://colab.research.google.com/drive/1D-e78pmMvJtntKWgbDeE97h7ymq0a6Es?usp=sharing)
+
+
+## 使用方法
+
+1. 設定パネルで、使用するモデル、APIキー、温度パラメータ、最大トークン数を指定します。
+
+2. ロールプレイする役割、話し方の口調、発話例、制約条件を入力します。
+
+3. 「送信」ボタンをクリックして、アシスタントとの会話を開始します。
+
+4. 「クリア」ボタンをクリックすると、チャット履歴がクリアされます。
+
+## カスタマイズ
+
+- `examples`変数に、あらかじめ定義されたロールプレイの例を追加できます。
+
+- `create_system_prompt`関数を変更することで、System promptの生成方法をカスタマイズできます。
+
+- `respond`関数を変更することで、アシスタントの応答生成方法をカスタマイズできます。
+
+## ライセンス
+
+このプロジェクトはMITライセンスの下で公開されています。詳細については、`LICENSE`ファイルを参照してください。
+
+## 貢献
+
+Pull requestやIssueは歓迎します。バグ報告や機能リクエストがある場合は、Issueを作成してください。
+
+## 連絡先
+
+- 作者: [@tregu0458](https://twitter.com/tregu0458)