From acc18697428da06d1ede759b761a767e0106aaf4 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Fri, 10 Mar 2023 17:51:56 +0100 Subject: [PATCH] Clarify readme docs --- doc/04-schema.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/04-schema.md b/doc/04-schema.md index 4278edc91..de4bf1600 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -133,7 +133,9 @@ Optional. ### readme -A relative path to the readme document. +A relative path to the readme document. Defaults to `README.md`. + +This is mainly useful for packages not on GitHub, as for GitHub packages Packagist.org will use the readme API to fetch the one detected by GitHub. Optional.