first commit

README.md

@@ -0,0 +1,36 @@
+# whisper-transcript
+
+이 웹 컴포넌트는 Whisper의 JSON 출력 결과를 그래픽으로 시각화하여 각 단어의 신뢰도와 타이밍을 확인할 수 있게 해줍니다.
+
+## 설치
+
+```bash
+yarn add whisper-transcript
+```
+
+## 사용법
+
+모듈을 로드합니다.:
+
+```html
+<script type="module" src="https://cdn.jsdelivr.net/npm/whisper-transcript@latest/dist/index.js"></script>
+
+그리고 아래와 같이 사용합니다.
+
+<whisper-transcript audio="media.mp3" url="media.json"></whisper-transcript>
+```
+
+비디오 파일도 가능합니다.:
+
+```html
+<whisper-transcript video="media.mp4" url="media.json"></whisper-transcript>
+```
+
+## Develop
+
+```bash
+yarn install
+yarn start
+```
+
+이 명령어는 demo 디렉토리에 있는 페이지를 엽니다. 필요하다면 audio.mp3와 audio.json 파일을 교체하여 생성한 스크립트를 테스트하고 확인할 수 있습니다.