Docker Hub README is outdated

[joshrotenberg]

Problem

The README on Docker Hub (https://hub.docker.com/r/joshrotenberg/redisctl) is outdated and doesn't reflect the current state of the project.

Current State

• Docker Hub shows an old README with outdated information
• Our main README.md in the repo is up-to-date with current features, installation instructions, and examples
• The Docker workflow doesn't push README updates to Docker Hub

Solutions

Option 1: Configure Docker Hub Auto-Sync (Recommended)

1. Log into Docker Hub
2. Go to repository settings
3. Configure automated builds or README sync from GitHub
4. Link to the GitHub repository
5. Set README source to the main README.md file

Option 2: Use GitHub Action to Push README

Add a step to the Docker workflow to update the README:

- name: Update Docker Hub README
  uses: peter-evans/dockerhub-description@v4
  with:
    username: ${{ secrets.DOCKERHUB_USERNAME }}
    password: ${{ secrets.DOCKERHUB_TOKEN }}
    repository: joshrotenberg/redisctl
    readme-filepath: ./README.md

Option 3: Manual Update

Manually copy the README content to Docker Hub through the web interface.

Action Items

• Decide on approach (recommend Option 1 or 2)
• If Option 1: Configure Docker Hub settings
• If Option 2: Add GitHub Action to docker.yml workflow
• Verify README is syncing on next release

Impact

Users visiting Docker Hub see outdated information which could lead to confusion about features, installation, and usage.

Related

• Docker workflow: .github/workflows/docker.yml
• Main README: README.md
• Docker Hub page: https://hub.docker.com/r/joshrotenberg/redisctl