From a643f619ec905f09cb3d8a8fa32497b7392fc9cc Mon Sep 17 00:00:00 2001 From: Albert Skalt Date: Mon, 30 Oct 2023 12:01:35 +0300 Subject: [PATCH] Update docs --- README.md | 6 ++++-- doc/examples.md | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 96e00ca71..4996e2f85 100644 --- a/README.md +++ b/README.md @@ -455,8 +455,10 @@ instance_name: parameter: value ``` -The dot and dash characters in instance names are reserved for system -use. if it is necessary for a certain instance to work on a source file +The dot character in instance names is reserved for system use. +Also, if an instance name ends with `-stateboard`, it will be recognized +as `stateboard`. +If it is necessary for a certain instance to work on a source file other than `init.lua`, then you need to create a script with a name in the format: `instance_name.init.lua`. diff --git a/doc/examples.md b/doc/examples.md index 471419946..11ab54bea 100644 --- a/doc/examples.md +++ b/doc/examples.md @@ -56,8 +56,8 @@ while true do end ``` -`instances.yml` (The dot and dash characters in instance names are -reserved for system use.): +`instances.yml` (The dot character in instance names is +reserved for system use): ``` yaml router: