docs: readme

daangn · Aug 2, 2024 · 66bb606 · 66bb606
1 parent 2d1334e
commit 66bb606
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/component-docs/README.md b/component-docs/README.md
@@ -1 +1,16 @@
 # component-docs
+
+### Folder Structure
+
+```sh
+component-docs
+ ┣ 📂components     # mdx 컴포넌트
+ ┣ 📂metadatas      # scripts로 생성하기 위한 컴포넌트 정보들
+ ┣ 📂pages          # 문서
+ ┣ 📂public         # 
+ ┃ ┗ 📂registry     #
+ ┃ ┃ ┗ 📂components # CLI로 install 할 때 참조
+ ┣ 📂schemas        #
+ ┣ 📂scripts        #
+ ┗ 📂snippets       # registry에 담김
+```