From 5be2104364da8ff0b9d205546dee70739461402f Mon Sep 17 00:00:00 2001
From: s-spindler <25225092+s-spindler@users.noreply.github.com>
Date: Tue, 24 May 2022 13:04:22 +0200
Subject: [PATCH] Add recommendation regarding PyPI friendly READMEs

---
 docs/cli.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/cli.md b/docs/cli.md
index f40f1bf885f..11de33fa6db 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -103,7 +103,9 @@ my-package
 
 * `--name`: Set the resulting package name.
 * `--src`: Use the src layout for the project.
-* `--readme`: Specify the readme file extension. Default is `md`.
+* `--readme`: Specify the readme file extension. Default is `md`. If you intend to publish to PyPI
+  keep the [recommendations for a PyPI-friendly README](https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/)
+  in mind.
 
 
 ## init