Merge remote-tracking branch 'upstream/master' into 1612-twitter-media

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

diff --git a/communityhome/README.md b/communityhome/README.md
index 3cf610ec17689aad9f90f2de3bf267d3a9be6bd9..21f2a9465f97389ea0d36325c93721e3e72ccdfe 100755 (executable)
--- a/communityhome/README.md
+++ b/communityhome/README.md
@@ -9,3 +9,26 @@ choosed to be in site directory), last ten public photos and last ten
 In main content is shown the community stream. This plugin 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