Merge pull request #500 from tobiasd/20180124-nsfwde3

[friendica-addons.git] / communityhome / README.md

diff --git a/communityhome/README.md b/communityhome/README.md
index 3cf610ec17689aad9f90f2de3bf267d3a9be6bd9..91838d9f17507bb6c360e1d4b645f4064b815296 100644 (file)
--- a/communityhome/README.md
+++ b/communityhome/README.md
@@ -1,11 +1,34 @@
 Community Home
 --------------
 
-This plugin overwrites the default home page shown to not logged users.
+This addon overwrites the default home page shown to not logged users.
 On sidebar there are the login form, last ten users (if they have 
 choosed to be in site directory), last ten public photos and last ten
 "likes" sent by a site user or about a site user's item
 
-In main content is shown the community stream. This plugin doesn't 
+In main content is shown the community stream. This addon doesn't 
 honour your community page visibility site setting: the community 
 stream is shown also if you have choose to not show the community page.
+
+If 'home.html' is found in your friendica root, its content is inserted 
+before community stream
+
+Each elements can be show or not. At the moment, there is no admin page
+for settings, so this settings must be added to yout .htconfig.php
+
+
+    $a->config['communityhome']['showcommunitystream'] = true;
+    $a->config['communityhome']['showlastlike'] = true;
+    $a->config['communityhome']['showlastphotos'] = true;
+    $a->config['communityhome']['showactiveusers'] = true;
+    $a->config['communityhome']['showlastusers'] = true;
+
+If you don't want to show something, set it to false.
+
+Note:
+-----
+
+- Default is "false". With no settings in .htconfig.php, nothing is 
+shown, except login form and content of 'home.html'
+
+- Active users query can be heavy for db, and on some system don't work