From 12e67c543e87c7fe5f54d60d9a2ad8e9e0e64174 Mon Sep 17 00:00:00 2001
From: tuna2134 <masato@priv.tuna2134.dev>
Date: Tue, 10 Sep 2024 23:27:18 +0000
Subject: [PATCH] add api description

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 2792f93..7f77ffa 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,19 @@ onnxsim使うことでモデルのサイズを軽くすることができます
 - [ ] 余裕があればPyO3使ってPythonで利用可能にする
 - [ ] GPU対応(優先的にCUDA)
 
+## ディレクトリー説明
+- `sbv2_api` - Style-Bert-VITS2の推論Web API
+- `sbv2_core` - Style-Bert-VITS2の推論コア部分
+
+## APIの起動方法
+```rs
+cargo run -p sbv2_api -r
+```
+
+### テストコマンド
+```bash
+curl -XPOST -H "Content-type: application/json" -d '{"text": "こんにちは"}' 'http://localhost:3000/synthesize'
+
 ## 謝辞
 - [litagin02/Style-Bert-VITS2](https://github.com/litagin02/Style-Bert-VITS2) - このコードの書くにあたり、ベースとなる部分を参考にさせていただきました。
 - [Googlefan](https://github.com/Googlefan256) - 彼にモデルをONNXヘ変換および効率化をする方法を教わりました。
\ No newline at end of file