From 8c075cde60427cb96cf7749bb4d09c4b0badf872 Mon Sep 17 00:00:00 2001
From: Wagner Macedo <wagnerluis1982@gmail.com>
Date: Sat, 13 Nov 2021 08:19:09 +0100
Subject: [PATCH] Add docs for multiple readme files support

Resolves #873
Related to python-poetry/poetry-core#118
---
 docs/pyproject.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/docs/pyproject.md b/docs/pyproject.md
index a0d1c896f41..e2e1811669f 100644
--- a/docs/pyproject.md
+++ b/docs/pyproject.md
@@ -73,6 +73,29 @@ The readme file of the package. **Optional**
 
 The file can be either `README.rst` or `README.md`.
 
+```toml
+[tool.poetry]
+# ...
+readme = "README.rst"
+```
+
+If you want to use multiple readme files, you can by wrapping the files in a list.
+
+```toml
+[tool.poetry]
+# ...
+readme = [
+    "README.rst",
+    "CHANGELOG.rst"
+]
+```
+
+{{% note %}}
+Note that a line break (`\n`) will be added between each file in the generated readme.
+
+Additionally, all the listed files must be of same type, i.e. you cannot mix `.rst` and `.md`.
+{{% /note %}}
+
 ## homepage
 
 An URL to the website of the project. **Optional**