add some docs

2025-01-03 15:16:23 +01:00
parent 45c06d081c
commit f7b369de95
5 changed files with 52 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,20 @@
+# What?
+
+This is a CLI for summarizing YouTubes
+
+## Installation
+
+```bash
+> python3 -m build && uv pip install --system dist/*.whl 
+```
+
+## Usage
+
+```bash
+> yts <youtube URL>
+```
+
+## Default Behavior
+
+The transcripts and summaries will be saved by default to `~/.yts/summaries` and `~/.yts/transcripts`.
+