From ea5a0752df2fa3dc07e94f1a552a2352c9607740 Mon Sep 17 00:00:00 2001 From: admin Date: Mon, 15 Jun 2026 03:58:56 +0000 Subject: [PATCH] Update README to reflect current behavior - Remove PDF-related references - Clarify DOCX format: no cover pages, transcript line-numbered - Align output files and env vars with current implementation --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e6ae5b3..cdf068d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ScrAIbe is a transcription and summarization service that: - Sends audio to a LocalAI server running vibevoice.cpp for transcription and speaker diarization. -- Optionally uses a second LLM to generate a detailed, structured summary. +- Optionally uses a second LLM to generate a structured summary. - Provides: - A web GUI for uploading audio and receiving transcripts via email. - A CLI and Python API for direct integration. @@ -29,12 +29,12 @@ For more information: https://apstrom.ca - Jobs are queued and processed in the background (Celery + Redis). - Emails: - Immediate confirmation with queue position. - - Final transcript (MD + JSON) when ready. - - Summary as MD file (if requested). + - Final transcript (MD + DOCX + JSON) when ready. + - Summary as MD + DOCX (if requested). - Error notification if processing fails. - File formats: - - Transcript: .md and .docx - - Summary (if requested): .md and .docx + - Transcript: .md and .docx (line-numbered, no cover page) + - Summary (if requested): .md and .docx (no line numbering, no cover page) - Full structured output: .json - Customizable branding: - Web GUI title, logo, and accent color via environment variables. @@ -256,12 +256,13 @@ Email subject lines (customizable): Output files (async web GUI): When a job completes, the user receives: + - Transcript: - .md file - - .docx file + - .docx file (line-numbered, no cover page) - Summary (if requested): - .md file - - .docx file + - .docx file (no line numbering, no cover page) - JSON: - Structured transcript with diarization and metadata