Add recommendation regarding PyPI friendly READMEs

python-poetry · May 24, 2022 · ad75670 · ad75670
1 parent 546e8b7
commit ad75670
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/cli.md b/docs/cli.md
@@ -101,7 +101,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