docs: add banner and restructure the README#30
Merged
Conversation
Add an SVG banner (audio waveform → diarized transcript, in Gladia's navy/cyan identity) and reorganize the README around it: - badges (build, release, license, Go version) - a one-line value prop and feature bullets - a "Start here" nav and a Quick start section - an everyday-examples block, plus pipe-friendly usage - shell completion collapsed into <details> to keep the page scannable All commands, flags, and language/diarization guidance are preserved.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME.md was restructured with new banner/badges, a condensed introduction, a consolidated "Quick start" section replacing prior Setup/Usage/Examples sections, updated Commands/Flags/Language/Diarization wording, collapsible shell completion blocks, and an updated license footer attribution. ChangesREADME documentation restructure
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
jqueguiner
approved these changes
Jul 7, 2026
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
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
Adds a banner image and restructures the README so the CLI's value is obvious in the first few seconds.
Banner
A self-contained SVG (
docs/assets/readme-banner.svg) in Gladia's navy/cyan identity: an audio waveform flowing into a terminal that shows a diarized transcript. No external assets, no fonts — renders as a static image on GitHub and animates subtly where SVG animation is allowed.README
-o json | jq<details>so the page stays scannableEvery existing detail — commands,
transcribeflags, the language matrix, and diarization guidance — is preserved, just reorganized. Usage examples now callgladia(onPATHafter the installer) rather than./gladia.Notes
Docs-only change; no code touched. Happy to tweak wording, colors, or the tagline to match your brand guidelines.
Summary by CodeRabbit