From ce57bb4e29f99be16aa730734e39c9595b974201 Mon Sep 17 00:00:00 2001
From: Kirill Gavrilov <gavvvr@users.noreply.github.com>
Date: Tue, 21 Jan 2025 21:55:36 +0300
Subject: [PATCH] docs: add description to README.md

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

diff --git a/README.md b/README.md
index 0d74d81..f411627 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,9 @@
 # Obsidian Timecodes Plugin
+
+Turns raw timecodes (`MM:SS`/`HH:MM:SS`) into clickable links in reading mode.
+
+Detects YouTube links of the following forms:
+
+- raw text links: `https://www.youtube.com/watch?v=...`
+- markdown links: `[video](https://www.youtube.com/watch?v=...)`
+- videos embedded into Obsidian note with `<iframe src="https://www.youtube.com/embed/...`