From: Decebal Suiu Date: Fri, 22 Feb 2013 16:34:57 +0000 (+0200) Subject: Update README.md X-Git-Tag: release-0.4~3 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=46784a26b3f462a6d8ac77c6c3f60f93fc2ba22e;p=pf4j.git Update README.md --- diff --git a/README.md b/README.md index bbc631c..c030117 100644 --- a/README.md +++ b/README.md @@ -152,16 +152,17 @@ For more information please see the demo sources. Enable/Disable plugins ------------------- -In theory, it's a relation 1:N between an extension point and the extensions for this extension point. -This works well, except for when you develop multiple plugins for this extension point as different options for your clients to decide on which one to use. -In this situation you wish a possibility to disable all but one extension. +In theory, it's a relation **1:N** between an extension point and the extensions for this extension point. +This works well, except for when you develop multiple plugins for this extension point as different options for your clients to decide on which one to use. +In this situation you wish a possibility to disable all but one extension. For example I have an extension point for sending mail (EmailSender interface) with two extensions: one based on Sendgrid and another -based on Amazon Simple Email Service. The first extension is located in Plugin1 and the second extension is located in Plugin2. -I want to go only with one extension (1:1 relation between extension point and extensions) and to achieve this I have two options: -1) uninstall Plugin1 or Plugin2 (remove from plugins folder pluginX.zip and pluginX folder) -2) disable Plugin1 or Plugin2 +based on Amazon Simple Email Service. +The first extension is located in Plugin1 and the second extension is located in Plugin2. +I want to go only with one extension ( **1:1** relation between extension point and extensions) and to achieve this I have two options: +1) uninstall Plugin1 or Plugin2 (remove folder pluginX.zip and pluginX from plugins folder) +2) disable Plugin1 or Plugin2 -For option two you must create a simple file enabled.txt or disabled.txt in your plugins folder. +For option two you must create a simple file enabled.txt or disabled.txt in your plugins folder. The content for enabled.txt is similar with: ######################################## @@ -180,7 +181,7 @@ The content for disabled.txt is similar with: ######################################## welcome-plugin -All comment lines (line that start with # character) are ignored. +All comment lines (line that start with # character) are ignored. If a file with enabled.txt exists than disabled.txt is ignored. See enabled.txt and disabled.txt from the demo folder. Demo