Skip to content
This repository has been archived by the owner on Oct 24, 2024. It is now read-only.

Commit

Permalink
Make long description show pictures on PyPi. (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
termim authored Aug 31, 2023
1 parent 059ac86 commit 4fcac11
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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?
Expand Down
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4fcac11

Please sign in to comment.