Skip to content

Update README to reflect current CLI flags, Postgres, and S3 support#33

Merged
andrew merged 1 commit intomainfrom
update-readme
Mar 18, 2026
Merged

Update README to reflect current CLI flags, Postgres, and S3 support#33
andrew merged 1 commit intomainfrom
update-readme

Conversation

@andrew
Copy link
Copy Markdown
Contributor

@andrew andrew commented Mar 18, 2026

The README still referenced old flag names and was missing documentation for features that have since been added.

  • Update Go version requirement from 1.23 to 1.25
  • Fix CLI flags to match actual names (-storage-url, -database-driver, -database-path, -database-url)
  • Add missing environment variables (PROXY_STORAGE_URL, PROXY_DATABASE_DRIVER, PROXY_DATABASE_URL)
  • Update config file example to use storage.url and database.driver
  • Add PostgreSQL documentation section
  • Add S3/S3-compatible storage documentation section
  • Replace inline Dockerfile with reference to the real one, add Postgres/S3 docker example
  • Update stats command examples with current flag names

The README still referenced old flag names (-storage, -database) and was
missing documentation for Postgres and S3 storage backends that have
since been added. Also bumps the listed Go version from 1.23 to 1.25.
@andrew andrew merged commit 9368d5c into main Mar 18, 2026
5 checks passed
@andrew andrew deleted the update-readme branch March 26, 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