From eb6779b327e22b34a6477e7dae20d485ac836423 Mon Sep 17 00:00:00 2001 From: Benjamin Bolte Date: Sat, 23 Nov 2024 00:56:38 -0800 Subject: [PATCH] update docs --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f9668d5..6e3a833 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,11 @@ # krec -K-Clips are the way that we collect data to train our AI models. +`krec` is a library for reading and writing K-Rec data. -## Append metadata to a video file +## Installation -### FFmpeg +```bash +pip install krec +``` -`ffmpeg -i test_video.mp4 -attach test.txt -metadata:s:t mimetype=application/octet-stream -metadata:s:t title="krec-001" -metadata:s:t uuid="123e4567-e89b-12d3-a456-426614174000" -metadata:s:t action="put the bunny back in the box" -c copy output_krec.mkv` - -## Read metadata - -### JS - -[ffmpeg-wasm](adhoc/web/full_meta.html) +See the [docs](https://docs.kscale.dev/models/krec) for more information.