Skip to content

Standardize README - #4

Merged
jay739 merged 1 commit into
mainfrom
readme-standard
Jul 15, 2026
Merged

jay739 merged 1 commit into
mainfrom
readme-standard

Conversation

@jay739

@jay739 jay739 commented Jul 15, 2026

Copy link
Copy Markdown
Owner

README brought to the documentation standard:

  • No em dashes and no emojis anywhere in prose
  • Configuration section lists every user-changeable variable in a table (scribe gained the previously undocumented SCRIBE_HOST and SCRIBE_DIARIZATION_MODEL)
  • Code blocks for all commands, install from releases where release automation exists
  • Stale facts corrected (license notes, model names, version references)
  • Links to CONTRIBUTING.md and SECURITY.md
  • Where applicable, CI trigger branches updated from master to main after the branch rename

@jay739
jay739 merged commit f8fabb1 into main Jul 15, 2026
1 check passed
@jay739
jay739 deleted the readme-standard branch July 15, 2026 01:36
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