Refactor README into Supabase/Vercel CLI house style#20
Merged
Conversation
Restructure the README around a centered header (title, tagline, nav links, badges) and Title Case task sections that each open with one imperative sentence plus a code block. Compress the prose while keeping the distinctive content (keyring security model, pipelines, --show-code). Disable MD033 (inline HTML) and MD041 (first-line H1) in markdownlint so the centered header passes the check.sh gate, matching how the Supabase and Vercel CLI repos configure their linters. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Refactors
README.mdto match the house style of the Supabase and Vercel CLI READMEs.Transcribe. Stream. Converse.), nav links, badges, and a---divider.--show-code.markdownlint
Disables
MD033(inline HTML) andMD041(first-line H1) in.markdownlint.json. The centered header is the house style and requires inline HTML; the Supabase and Vercel CLI repos disable these same rules.markdownlint README.mdpasses (exit 0).Notes
assemblyai-cliPyPI name is squatted and the package isn't published there.D6402E); swap in AssemblyAI's exact brand hex if preferred.🤖 Generated with Claude Code