From 7fc77e10d06b1ac7f2fdd5302731c0cc32421200 Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Sat, 14 Dec 2024 13:04:06 +0100 Subject: [PATCH] Add Explanation that there are two ways to configure --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f7b8dc..289ac40 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ git pull To use this module, add a configuration to the modules array in the `config/config.js` file. +There are two ways to configure this module: Using the module names or using class names. The module name based configuration is easier to use, but has the limitations that you can only use one instance of each module. So if you want to use multiple instances of the same module, you have to use the class based configuration. + *Note*: Some of the module names used in the following examples are fictitious. ### Module name based configuration @@ -93,8 +95,6 @@ The first element of the array is the first page, the second element is the seco }, ``` -*Note:* This way you can only use one instance of each module. If you want to use multiple instances of the same module, you have to use the class based configuration. - ### Class based configuration Instead of using the module name, you can also use a class name for each page. This way you can have multiple instances of the same module on different pages.