DOC Hardcode the GitHub links in the README

[stephen-hoover]

Relative links are broken in DockerHub, so they need to be hardcoded here. Remember to update these with each new release!

Closes #54 .

[mheilman]

I kinda don't like having to update the README every time manually. If we're going to do something manually, is it possible to update the dockerhub readme manually? e.g., https://stackoverflow.com/questions/29134275/how-to-push-a-docker-image-with-readme-file-to-docker-hub (I don't seem to have permissions to edit it on DockerHub thought)

[stephen-hoover]

I really don't like it either, but I haven't thought of anything better. I'm also unable to edit the information on DockerHub, and the documentation suggests it's not possible:

https://docs.docker.com/docker-hub/builds/#understand-the-build-process

The build process looks for a README.md in the same directory as your Dockerfile. If you have a
README.md file in your repository, it is used in the repository as the full description. If you change the full description after a build, it’s overwritten the next time the Automated Build runs. To make changes, modify the README.md in your Git repository.

[mheilman]

Could we just add a note to the top of the README? e.g.,

If you're viewing this README on DockerHub, the links will not work. Click here to view the README on GitHub.

[stephen-hoover]

I'd be happy with that. (I think it will still be the case that users will be directed to the master branch, and risk getting development versions of the files. But that's not different from the current state of affairs.) @keithing , you reported this issue -- what do you think of Mike's proposed solution?

[keithing]

Great idea. Let's do it.

[stephen-hoover]

Closed in favor of #56 .