Skip to content

docs: add status badges and a Quick start section#52

Merged
daichirata merged 1 commit into
masterfrom
docs/badges-and-quickstart
May 21, 2026
Merged

docs: add status badges and a Quick start section#52
daichirata merged 1 commit into
masterfrom
docs/badges-and-quickstart

Conversation

@daichirata

Copy link
Copy Markdown
Owner

Summary

Visual polish for the README top half — no functional changes.

  • Status badges under the title: test workflow, latest release, Go version, license. The repo's state is now visible at a glance.
  • Quick start section directly after the architecture diagram. A single Docker one-liner that reuses the reader's existing Application Default Credentials lets them verify gcsproxy works in 30 seconds before scrolling through Features / Installation / Usage.

Preview

# gcsproxy

[Test ✓] [Release v0.4.4] [Go 1.25] [License MIT]

A lightweight reverse proxy for Google Cloud Storage.
... description ...
... ASCII diagram ...

## Quick start

docker run --rm -p 8080:80 \
    -e GOOGLE_APPLICATION_CREDENTIALS=/cred.json \
    -v ~/.config/gcloud/application_default_credentials.json:/cred.json \
    ghcr.io/daichirata/gcsproxy:latest -b 0.0.0.0:80

curl http://localhost:8080/<your-bucket>/<your-object>

Test plan

  • No code changes; existing tests unaffected
  • Badge URLs follow GitHub / shields.io conventions; will resolve once the PR is merged and rendered on master

🤖 Generated with Claude Code

- Adds a row of badges under the title (test workflow status, latest
  release, Go version, license) so the project state is visible at a
  glance.
- Adds a Quick start section right after the diagram with a one-liner
  Docker invocation that reuses the local Application Default
  Credentials. Lets new readers verify the proxy works in 30 seconds
  before scrolling through Features / Installation / Usage.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@daichirata daichirata merged commit fae1dce into master May 21, 2026
1 check passed
@daichirata daichirata deleted the docs/badges-and-quickstart branch May 21, 2026 09:28
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