Update README.md

README.md

@@ -1,8 +1,66 @@
-## GPT-API 브랜치 설명
-기능 별로 브랜치를 나눴고, 가장 성능이 좋은 방법을 사용할 예정입니다.
-
-* Feat/#1 => 영어로 번역한 후 gpt에 되묻기 (성능 확인)
-* Feat/#2 => Few shot skill을 이용해서 gpt에 요청할 때 칭찬의 예시도 함께 보낸다.
-* Feat/#3 => WebClient 방식으로 외부 api 사용하기 **main에 Merge 완료**
-* Feat/#5 => GPT 4.0으로 변경
-* Feat/#6 => #5(GPT4.0)로 부터 branch 생성. #2의 Few shot skill을 적용해서 여러 감사일기에도 독립된 칭찬이 나오게 구현
+# 🍀 Clody
+> ### 사용자의 감사일기에 AI(클로디)가 칭찬으로 답장해주는 서비스
+
+**클로디**는
+사용자의 감사일기에 AI 캐릭터가 칭찬으로 답장해주는 서비스입니다.
+
+</div>
+
+<br>
+
+## 🧠 GPT-API
+클로디의 **두뇌** 구현
+
+=> 사용자가 감사일기를 작성하면, 이 일기를 GPT API를 통해 요청하여 칭찬 메시지를 생성하고 출력하도록 설계했습니다. 
+
+[AI Brain of Clody ; Notion](https://petite-blizzard-e22.notion.site/f2ea976ea6044d05972f8a6ce27676f4?v=1bf109975be64b52a1f4f5c5d3984cb6)
+
+</div>
+
+<br>
+
+## 📌GPT-API 브랜치 설명
+AI 답장 기능의 성능을 높이기 위해 여러 방법으로 구현하였고, 가장 성능이 좋은 방법을 사용하였습니다.
+
+* [Feat/#1](https://github.com/Yangdaehan/GPT-API/tree/Feat/%231) => 영어로 번역한 후 gpt에 되묻기 (사용 x)
+* [Feat/#2](https://github.com/Yangdaehan/GPT-API/tree/Feat/%232) => Few shot skill을 이용해서 gpt에 요청할 때 칭찬의 예시도 함께 전송
+* [Feat/#3](https://github.com/Yangdaehan/GPT-API/tree/Feat/%233) => WebClient 방식으로 외부 api 사용하기 
+* [Feat/#5](https://github.com/Yangdaehan/GPT-API/tree/Feat/%235) => GPT 4.0으로 변경
+* [Feat/#6](https://github.com/Yangdaehan/GPT-API/tree/Feat/%236) => #5(GPT4.0)로 부터 branch 생성. #2의 Few shot skill을 적용해서 여러 감사일기에도 독립된 칭찬이 나오게 구현
+* [Feat/#8](https://github.com/Yangdaehan/GPT-API/tree/Feat/%238) => #3(WebClient)로 부터 branch 생성. 비속어 필터링 구현
+* Feat/#9 => #8(비속어 필터링)로 부터 branch 생성. AMQP 구현을 위한 RabbitMQ 적용 (사용 x)
+* [Feat/#10](https://github.com/Yangdaehan/GPT-API/tree/Feat/%2310) => Postgresql 데이터베이스에 칭찬 저장 **GPT 3.5 최종본**
+* [Feat/#12](https://github.com/Yangdaehan/GPT-API/tree/Feat/%2312)=> **GPT 4.0 최종본**
+
+</div>
+
+<br>
+
+## 🖥️ Foldering
+```
+─src
+    ├─main
+    │  ├─java
+    │  │  └─org
+    │  │      └─sopt
+    │  │          └─gptapi
+    │  │              ├─common
+    │  │              │  └─dto
+    │  │              ├─config
+    │  │              ├─controller
+    │  │              ├─domain
+    │  │              │  ├─reply
+    │  │              │  └─user
+    │  │              ├─dto
+    │  │              ├─listener
+    │  │              └─service
+    │  │                  ├─dto
+    │  │                  ├─reply
+    │  │                  └─user
+    │  └─resources
+    └─test
+        └─java
+            └─org
+                └─sopt
+                    └─gptapi
+```