devmtl/readme-to-dockerhub repository overview

⁠readme-to-dockerhub⁠

Push README.md files to Docker hub.

Thanks to SISheogorath for this project. You can find the sources here:
https://github.com/SISheogorath/readme-to-dockerhub⁠

⁠Regarding Github Actions & CI configuration

See README-CI.md⁠

⁠Docker hub

Always check on docker hub the most recent build:
https://hub.docker.com/r/devmtl/resilio/tags⁠

You should use this tag format $VERSION_$DATE_$HASH-COMMIT in production.

devmtl/readme-to-dockerhub:1.0_2019-09-02_10H38s35_ca032df

These tags are also available to test stuff quickly:

devmtl/readme-to-dockerhub:1.0
devmtl/readme-to-dockerhub:stable
devmtl/readme-to-dockerhub:latest

⁠How to use it

docker run --rm \
  -v $(pwd)/README.md:/data/README.md \
  -e DOCKERHUB_USERNAME="devmtl" \
  -e DOCKERHUB_PASSWORD="${DOCKERHUB_PASSWORD}" \
  -e DOCKERHUB_REPO_PREFIX="devmtl" \
  -e DOCKERHUB_REPO_NAME="readme-to-dockerhub" \
  devmtl/readme-to-dockerhub:stable

⁠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

Brought to you by

⁠

FirePress.org⁠ | play-with-ghost⁠ | GitHub⁠ | Twitter⁠

⁠Hosting

At FirePress we empower entrepreneurs and small organizations to create their websites on top of Ghost⁠.

At the moment, our pricing for hosting one Ghost website is $15 (Canadian dollars). This price will be only available for our first 100 new clients, starting May 1st, 2019 🙌. See our pricing section⁠ for details.

More details about this annoucement⁠ on Ghost's forum.

⁠Contributing

The power of communities pull request and forks means that 1 + 1 = 3. You can help to make this repo a better one! Here is how:

1. Fork it
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request

Check this post for more details: Contributing to our Github project⁠. Also, by contributing you agree to the Contributor Code of Conduct on GitHub⁠. It's plain common sense really.

⁠License

• This git repo is under the GNU V3 license. Find it here⁠.

⁠Why all this work?

Our mission⁠ is to empower freelancers and small organizations to build an outstanding mobile-first website.

Because we believe your website should speak up in your name, we consider our mission completed once your site has become your impresario.

For more info about the man behind the startup, check out my now page⁠. You can also follow me on Twitter @askpascalandy⁠.

— The FirePress Team 🔥📰