From 4fcac11779fa79ef69ab1ca6afd5b67155e214a3 Mon Sep 17 00:00:00 2001 From: Mikhail Terekhov Date: Thu, 31 Aug 2023 10:56:04 -0400 Subject: [PATCH] Make long description show pictures on PyPi. (#23) --- README.md | 6 +++--- setup.py | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ef04bce..54cd1ec 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Transfer your Docker images to an air-gapped system efficiently. (An air-gapped system is a system that is not connected to the internet) -![](./images/logo.jpg) +![](https://github.com/gabrieldemarmiesse/docker-charon/blob/cbf5e2a6f50152c6754000ae8c0551c884450f15/images/logo.jpg) From wikipedia: @@ -302,7 +302,7 @@ This is actually what is recommended for simple use cases. Here is the recap of the `docker pull -> docker save -> docker load -> docker push` method: -![](./images/with_docker_save_load.png) +![](https://github.com/termim/docker-charon/blob/a2a499a715f42947fb940bc4a808b23c316994d4/images/with_docker_save_load.png) But let's say that you want to scale your deliveries, make regular updates, you'll soon @@ -325,7 +325,7 @@ transferred a second time. Here is the recap of the docker-charon method: -![](./images/with_docker_charon.png) +![](https://github.com/termim/docker-charon/blob/a2a499a715f42947fb940bc4a808b23c316994d4/images/with_docker_charon.png) ### How does it work? diff --git a/setup.py b/setup.py index 89ed914..fc2f92f 100644 --- a/setup.py +++ b/setup.py @@ -13,6 +13,8 @@ def get_long_description() -> str: name="docker-charon", version=(CURRENT_DIR / "VERSION.txt").read_text(encoding="utf8").strip(), description="A tool to move your Docker images to an air-gapped registry.", + long_description=get_long_description(), + long_description_content_type="text/markdown", install_requires=(CURRENT_DIR / "requirements.txt").read_text().splitlines(), packages=find_packages(), include_package_data=True, # will read the MANIFEST.in