From 59388247417f9961c8c9b32ac6b968659998da5e Mon Sep 17 00:00:00 2001 From: polv Date: Tue, 3 Feb 2026 14:22:51 +0700 Subject: [PATCH] update README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 37a4be22..5e8c920a 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,12 @@ Choose any method to download your video and save it to `/docs/public` directory ### Step 2: Create a Markdown File -Create a markdown file in `/docs` directory. The filename should match the video filename with `[xxx]` removed. +Create a markdown file in `/docs` directory. The filename should match the video filename with `[xxx]` removed and spaces replaced with underscores. For example: -- Video file: `my-video[abc123].mp4` → Markdown file: `my-video.md` +- Video file: `my video [abc123].mp4` → Markdown file: `my_video.md` - Video file: `presentation.mp4` → Markdown file: `presentation.md` +- Video file: `my-video [xyz].mp4` → Markdown file: `my-video.md` The markdown file content can be: @@ -85,9 +86,10 @@ docs/ # VitePress documentation root theme/ components/ Downloader.vue # Vue component for the downloader interface + Video.vue # Vue component to display videos and linked timestamps public/ # Video storage directory *.md # Markdown files with content - [video-folder]/ # Screenshot folders (auto-generated) + [video-filename]/ # Screenshot folders (auto-generated) *.png # Timestamped screenshots server.js # WebSocket server for handling downloads group-similar.js # Script for deduplicating similar screenshots @@ -99,4 +101,4 @@ group-similar.js # Script for deduplicating similar screenshots - VitePress for static site generation - WebSocket for real-time communication between browser and server - gray-matter for parsing YAML frontmatter -- Sharp for image processing (screenshot manipulation) +- [Sharp](https://github.com/lovell/sharp) for image processing (screenshot manipulation)