diff --git a/plugins/Karma/README.txt b/plugins/Karma/README.txt index d60b47a97..922af9197 100644 --- a/plugins/Karma/README.txt +++ b/plugins/Karma/README.txt @@ -1 +1,7 @@ -Insert a description of your plugin here, with any notes, etc. about using it. +This will increase or decrease karma for the item. + +If "config plugins.karma.allowUnaddressedKarma" is set to true, saying "boats++" will give 1 karma to "boats", and "ships--" will subtract 1 karma from "ships". + +However, if you use this in a sentence, like "That deserves a ++. Kevin++", 1 karma will be added to "That deserves a ++. Kevin", so you should only add or subtract karma in a line that doesn't have anything else in it. + +If "config plugins.karma.allowUnaddressedKarma" is set to false, you must use "botname: bots++" to add or subtract karma.