Bug fix for Twitter

[friendica-addons.git] / nsfw / README

diff --git a/nsfw/README b/nsfw/README
old mode 100755 (executable)
new mode 100644 (file)
index c65394a..e4a8b9d
--- a/nsfw/README
+++ b/nsfw/README
@@ -6,7 +6,7 @@ Scans the message content for the string 'nsfw'
 (case insensitive) and if found replaces the content
 with a "click to open/close" link, default is closed.
 
-If you click on the 'Not safe for work' plugin under
+If you click on the 'Not safe for work' addon under
 /settings/addon a text field appears, where you can
 extend the list of search terms. The terms must be
 seperated by commas.
@@ -47,7 +47,25 @@ done with a single regex, which matches all of them:
 Another use case could be, that you are simply not
 interested in postings about christmas.
 
-       /christmas([-_ ]?(tree|time|eve|pudding))?/
+       /christmas(?:[-_ ]?(?:tree|time|eve|pudding))?/
+
+
+ATTENTION:
+
+It is absolutely important, that you use grouping
+parentheses instead of capturing parentheses!!
+
+Grouping parentheses are:
+
+       (?: )
+
+If you use capturing parentheses, which are
+
+       ( )
+
+it will produce errors and the regex won't work and
+at least your targets will not get collapsed.
+
 
 
 3)
@@ -64,7 +82,7 @@ This can be prevented by
 
        /\badvent\b/
 
-The first part if the regex above
+The first part of the regex above
 
        (?<!the )