frangal/readme-dockerhub repository overview

⁠README to Docker Hub

This is a quick hack to push README.md files to Docker hub.

⁠How to use?

Simply build the image using docker build -t readme-dockerhub .

and run it with all needed parameter:

docker run --rm \
    -v /path/to/readme.md:/data/README.md \
    -e DOCKERHUB_USERNAME=myhubuser \
    -e DOCKERHUB_PASSWORD=myhubpassword \
    -e DOCKERHUB_REPO_PREFIX=myorga \
    -e DOCKERHUB_REPO_NAME=myrepo \
     readme-dockerhub

That's it.

⁠Environment variables

This image uses environment variables for configuration.

⁠Mount the README.md

By default, if the README_PATH environment variable is not set, this image always pushes the file /data/README.md as full description to Docker Hub.

For GitHub repositories you can use -v /path/to/repository:/data/.

If your description is not named README.md mount the file directory using -v /path/to/description.md:/data/README.md.

Notice that the filename is case sensitive. If your readme is called readme.md you have to mount the file directly, not the directory

⁠License

View license information⁠ for the software contained in this image.

Everything in this repository⁠ is published under GPL-3⁠.