diff --git a/README.md b/README.md index 875578c..4b9a93b 100644 --- a/README.md +++ b/README.md @@ -10,23 +10,25 @@ see any payment messages. For testing, you'll need to un-set the `paidsigns.paym As this plugin only listens to sign change events, there are some limitations: -1. The plugin is not aware of whether the creation of a sign is successful. Setting the appropriate permission might help, but it's not guaranteed +1. The plugin is not aware of whether the creation of a sign is successful. Setting the appropriate permission might + help, but it's not guaranteed 2. It is assumed that any protection plugins run before this plugin checks a sign, but it's not guaranteed -3. Plugins changing the lines on signs when successful might create confusion and mismatches if changes happen before this plugin checks a sign +3. Plugins changing the lines on signs when successful might create confusion and mismatches if changes happen before + this plugin checks a sign ## Commands -An argument marked by "<>" is required to execute the command. An argument marked by "[]" is optional. -For empty arguments, such as no paid sign permission, you should use empty quotes (""). +An argument marked by "<>" is required to execute the command. An argument marked by "[]" is optional. For empty +arguments, such as no paid sign permission, you should use empty quotes (""). | Command | Arguments | Permission | Description | | -------- | ------ | ------- | ------- | -| /addpaidsign | \ \ \[permission] \[ignore case] \[ignore color] \[match any condition] | paidsigns.manage | Used to add a new paid sign | -| /addpaidsigncondition | \ \ \ \[executeRegEx] \[ignoreCase] \[ignoreColor] | paidsigns.manage | Used to add a condition to a paid sign | -| /listpaidsigns | \[name (of a paid sign)] \[line number] | paidsigns.manage | Used to list registered paid signs or a registered paid sign's conditions | -| /editpaidsign | \ \/\ \[new value]/\ \[new value] | paidsigns.manage | Used to modify a registered paid sign or one of its conditions | -| /removepaidsigncondition | \ \ | paidsigns.manage | Used to remove a condition from a registered paid sign | -| /removepaidsign | \ | paidsigns.manage | Used to remove a registered paid sign | +| [/addpaidsign](#addpaidsign) | \ \ \[permission] \[ignore case] \[ignore color] \[match any condition] | paidsigns.manage | Used to add a new paid sign | +| [/addpaidsigncondition](#addpaidsigncondition) | \ \ \ \[executeRegEx] \[ignoreCase] \[ignoreColor] | paidsigns.manage | Used to add a condition to a paid sign | +| [/listpaidsigns](#listpaidsigns) | \[name (of a paid sign)] \[line number] | paidsigns.manage | Used to list registered paid signs or a registered paid sign's conditions | +| [/editpaidsign](#editpaidsign) | \ \/\ \[new value]/\ \[new value] | paidsigns.manage | Used to modify a registered paid sign or one of its conditions | +| [/removepaidsigncondition](#removepaidsigncondition) | \ \ | paidsigns.manage | Used to remove a condition from a registered paid sign | +| [/removepaidsign](#removepaidsign) | \ | paidsigns.manage | Used to remove a registered paid sign | | /reload | | paidsigns.reload | Used to reload the configuration file | ## Command explanation @@ -140,5 +142,5 @@ Remember to change the language code to whichever you use for your custom langua ## License -PaidSigns is licensed under the GNU Public License Version 3.0. This includes every source and resource file. See -the HEADER file for a more detailed license description. \ No newline at end of file +PaidSigns is licensed under the GNU Public License Version 3.0. This includes every source and resource file. See the +HEADER file for a more detailed license description. \ No newline at end of file