Improve README intro for first-time visitors#469
Merged
Conversation
Rework the top of the README so a visitor can tell what the project is and try it out within seconds: - Replace the flat opening lines with a single tagline that leads with what makes the project unique and the pain it removes. - Add a Sponsor badge next to the existing badges. - Add a copy-pasteable "Quick start" section before "Features", with links to the full Install and standalone-server sections. - Mention go-googlesql in the architecture overview so the GoogleSQL frontend powering query execution is discoverable. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The `docker run` examples started the container without `-p`, so the REST (9050) and gRPC (9060) ports were never published to the host. A `bq`/client call against the host then fails with "Connection refused". Map both ports so the examples work as written. Co-Authored-By: Claude Opus 4.7 (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
1 participant
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.
Summary
Reworks the top of the README so a visitor — particularly one arriving from an external link such as Hacker News — can tell what the project is and try it out within seconds.
docker run/bq querysnippet before "Features", with links down to the full Install and standalone-server sections.Content-only change to
README.md; no code or behavior changes.Follow-up (not in this PR)
A demo GIF / asciinema recording near the top would further help conversion, but that is an asset that needs to be produced separately.
🤖 Generated with Claude Code