Add header image

shun-liang · Oct 15, 2024 · fc95635 · fc95635
1 parent 37089d4
commit fc95635
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # yt2doc
 
+![Header Image](header-image.png)
+
 yt2doc transcribes videos online into readable Markdown documents.
 
 Supported video sources:
@@ -8,6 +10,8 @@ Supported video sources:
 
 yt2doc is meant to work fully locally, without invoking any external API. The OpenAI SDK dependency is required solely to interact with [Ollama](https://github.com/ollama/ollama).
 
+Check out some [examples](./examples/) generated by yt2doc.
+
 ## Why
 
 There have been many existing projects that transcribe YouTube videos with Whisper and its variants, but most of them aimed to generate subtitles, while I had not found one that priortises readability. Whisper does not generate line break in its transcription, so transcribing a 20 mins long video without any post processing would give you a huge piece of text, without any line break or topic segmentation. This project aims to transcribe videos with that post processing. 

diff --git a/header-image.png b/header-image.png