Skip to content

docs: rebuild README as a landing page with real CLI output - #88

Merged
ekhodzitsky merged 1 commit into
masterfrom
docs/readme-v2
Jul 31, 2026
Merged

docs: rebuild README as a landing page with real CLI output#88
ekhodzitsky merged 1 commit into
masterfrom
docs/readme-v2

Conversation

@ekhodzitsky

Copy link
Copy Markdown
Owner

Что

Вторая итерация README после критики:

  • Реальный вывод CLI вместо выдуманных таймкодов (записан настоящий прогон на VoxConverse);
  • 60-секундный quickstart одним блоком: бинарь → модели → diarize → RTTM;
  • Компактный install — таблица платформ вместо трёх дублирующих curl-блоков; убран sudo mv;
  • Позиционирование («для кого») в первом абзаце;
  • Числа fast-профиля заполнены + оговорка про AMI-домен; замечание, что конкуренты не публикуют CPU RTF (WhisperX > 1 на CPU);
  • Секция Status: честно про beta/0.x и стабильность API;
  • Бейджи release + codecov; размер моделей «30 MB (8.4 MB INT8)».

- Add a recorded asciinema GIF of an actual diarization run
  (docs/assets/demo.gif, 23 KB) instead of illustrative output
- Add a 60-second quickstart (binary -> models -> diarize -> RTTM)
- Collapse the install section into a compact per-platform table
- Fill the INT8 fast-profile numbers and state its DER caveat; note
  that competitors do not publish CPU RTF
- Add a Status section (beta, 0.x API stability) and release/codecov
  badges; state the target audience up front
@ekhodzitsky
ekhodzitsky merged commit f2bf57f into master Jul 31, 2026
47 checks passed
@ekhodzitsky
ekhodzitsky deleted the docs/readme-v2 branch July 31, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant