From 176e398a3567ece12ecdf27b87a5e9c92c71cdfd Mon Sep 17 00:00:00 2001 From: Joe Huss Date: Sun, 28 Jun 2026 22:59:12 -0400 Subject: [PATCH] docs: note required:true settings need a default or host null-fills Follow-up to phlix-server #329 which fixed PluginLoader::defaultSettings() to null-fill required:true settings that lack a default. Document this behavior in the plugin example README under 'Fork as a starter'. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a8b9ba0..fd2c74a 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,10 @@ file) so you can copy it as the seed for your own plugin: events. See the full schema in [`docs/plugins/manifest.schema.json`](https://github.com/detain/phlix/blob/master/docs/plugins/manifest.schema.json) in the main repo. + + > **Note:** If you declare a setting `required:true`, give it a `default` + > or the host will null-fill it — see + > [`docs/plugins/manifest.md`](https://github.com/detain/phlix/blob/master/docs/plugins/manifest.md). 3. Edit **`composer.json`** — rename the package, change the PSR-4 prefix under `autoload.psr-4`. 4. Rewrite **`src/HelloMetadataProvider.php`** with your own