From 1974d37646007bd71cb201dfdb65518d260494f3 Mon Sep 17 00:00:00 2001 From: KongQun Yang Date: Mon, 13 Aug 2018 12:00:53 -0700 Subject: [PATCH] Update comment style in README.md So it displays properly in both GitHub and Docker Hub. Related to #408. Change-Id: If16e985d9ba22b619c25737ad7e315e22e942733 --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 37818ff0a0..5b8dd06d7e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ - +[comment]: # (While not ideal, absolute URLs are used here as it is the ) +[comment]: # (simplest way to make the links work on GitHub and Docker Hub. ) +[comment]: # (These links in cloned repositories will point back to the main ) +[comment]: # (repository and if it is an issue, we suggest updating the links ) +[comment]: # (in the cloned repository. ) +[comment]: # (See https://github.com/google/shaka-packager/issues/408 for the ) +[comment]: # (full background. ) ![Shaka Packager](https://raw.githubusercontent.com/google/shaka-packager/master/docs/shaka-packager.png)