README updated, code restructured

discourse/README

@@ -1,97 +1,28 @@
-NSFW
+Discourse connector
+===================
 
-"Not safe for work"
+The Discourse connectors detects incoming mails from Discourse and
+improves them by fetching the content and user data via API.
 
-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.
+Prerequisites
+-------------
+The user has to configure the mail interface so that the user's mails
+can be fetched via Friendica. Then the user has to activate the
+mailing list mode in Discourse.
 
-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.
+The mailing list mode in Discourse knows two different options:
+1. Get all posts - including your own. This will create duplicates
+   if you post via Friendica.
+2. Don't get your own posts. Then you will missing all your posts
+   that you made directly on Discourse. Since you cannot create
+   a new post via this connector (only comments are possible)
+   this is not a goog choice either.
 
-It is also possible to enter profile URLs as values.
-This is quite useful for the case, that you perhaps
-don't want to see postings by person_A, but person_B
-is one of your contacts and person_B used to reshare
-postings by person_A.
-
-You can also make use of regular expressions.
-They also have to be seperated by commas and the
-regex itself has to be enclosed with slashes:
-
-	... nsfw, /<REGEX>/, politics,...
-
----------------
-A few examples:
----------------
-
-1)
-Let's say you don't want to see postings which contain
-the term 'fake news'
-
-The term could appear in several ways:
-
-fakenews, fake news, fake_news, fake-news, f@ke news,
-f4ke news, f4k3 n3ws, and so on and so on and so on.
-
-You could write every possible version of it as single
-item into your NSFW-filter list, but this can also be
-done with a single regex, which matches all of them:
-
-	/f[@4a]k[3e][-_ ]n[3e]w[sz]/
-
-
-2)
-Another use case could be, that you are simply not
-interested in postings about christmas.
-
-	/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)
-Another possibility is the usage of a so called
-'lookbehind' construct. I'll give an example followed
-by a descripton:
-
-	/(?<!the )\badvent\b/
-
-The \b is a word boundary, what matches the beginning
-and the end of a word. The simple pattern of 'advent'
-would match advent iteself, but also adventure.
-This can be prevented by
-
-	/\badvent\b/
-
-The first part of the regex above
-
-	(?<!the )
-
-is a negative lookbehind. It makes \badvent\b only
-match, if there is no 'the ' before \badvent\b or in
-words:
-
-It looks for 'advent', but doesn't match 'the advent'.
-
-
-For more informations take a look at the PCRE regex
-dialect.
+Known problems
+--------------
+- You can't create starting posts
+- Either you don't get your own posts you made directly on Discourse
+  or you do get duplicates for every post you made via Friendica.
+- Non public categories are currently only working via some workaround
+  without the API, which most likely will cause some content problems.
+- links to Discourse profiles in the posts are invalid.