Merge pull request #117 from Mkaysi/attackprotector-readme

AttackProtector: convert README to markdown
master
Valentin Lorentz 2012-12-29 15:56:36 -08:00
commit 9178963581
1 changed files with 13 additions and 3 deletions

View File

@ -1,15 +1,25 @@
This plugin aims to provide a highly configurable protection against flood
and spam.
There is two kind of detections:
- individual: they are the most common flood, so there name in configuration
AttackProtector
===============
Detection types
---------------
There are two kind of detections:
**individual**: they are the most common flood, so there name in configuration
is the name of the flood type
- groupped: it's a flood from several nicks. There name in the configuration
**groupped**: it's a flood from several nicks. There name in the configuration
is the flood type, prepended by 'group'.
Of course, detection value of group flood should be greater than the
individual flood's.
Punishment types
----------------
For each flood type, you can define a punishment. More common are 'ban',
'kick', 'kban'. You also can define modes, such as the default punishment