Merge remote-tracking branch 'friendica/master'

[friendica-addons.git] / facebook / README

diff --git a/facebook/README b/facebook/README
index 325f18dd1252acad753c11067a68de6cde2f156e..9687558e70bd9a0d1b8aefd167e4aea1a8f64402 100755 (executable)
--- a/facebook/README
+++ b/facebook/README
@@ -1,15 +1,15 @@
-Installing the Friendika/Facebook connector
+Installing the Friendica/Facebook connector
 
 1. register an API key for your site from developer.facebook.com
-  a. We'd be very happy if you include "Friendika" in the application name
-     to increase name recognition. The Friendika icons are also present
+  a. We'd be very happy if you include "Friendica" in the application name
+     to increase name recognition. The Friendica icons are also present
      in the images directory and may be uploaded as a Facebook app icon.
-     Use images/friendika-16.jpg for the Icon and images/friendika-128.jpg for the Logo.
+     Use images/friendica-16.jpg for the Icon and images/friendica-128.jpg for the Logo.
   b. The url should be your site URL with a trailing slash.
      You may use http://portal.friendika.com/privacy as the privacy policy
      URL unless your site has different requirements, and 
      http://portal.friendika.com as the Terms of Service URL unless
-     you have different requirements. (Friendika is a software application
+     you have different requirements. (Friendica is a software application
      and does not require Terms of Service, though your installation of it might).
   c. Set the following values in your .htconfig.php file
         $a->config['facebook']['appid'] = 'xxxxxxxxxxx';
@@ -17,13 +17,18 @@ Installing the Friendika/Facebook connector
      Replace with the settings Facebook gives you.
   d. Navigate to Set Web->Site URL & Domain -> Website Settings.  Set Site URL 
      to yoursubdomain.yourdomain.com.  Set Site Domain to your yourdomain.com.
+  e. Chose "Website" (the url should be your site URL with a trailing slash) in the
+     "Select how your app integrates with Facebook" section.
 2. Enable the facebook plugin by including it in .htconfig.php - e.g. 
     $a->config['system']['addon'] = 'plugin1,plugin2,facebook';
 3. Visit the Facebook Settings section of the "Settings->Plugin Settings" page.
    and click 'Install Facebook Connector'.
 4. This will ask you to login to Facebook and grant permission to the 
    plugin to do its stuff. Allow it to do so. 
-5. You're done. To turn it off visit the Plugin Settings page again and
+5. Optional step: If you want to use Facebook Real Time Updates (so new messages
+   and new contacts are added ~1min after they are postet / added on FB), go to
+   Settings -> plugins -> facebook and press the "Activate Real-Time Updates"-button.
+6. You're done. To turn it off visit the Plugin Settings page again and
    'Remove Facebook posting'.
 
 Vidoes and embeds will not be posted if there is no other content. Links 
@@ -34,6 +39,6 @@ Facebook contacts will not be able to view private photos, as they are not able
 authenticate to your site to establish identity. We will address this 
 in a future release.
 
-Info: please make sure that you understand all aspects due to Friendika's 
-default licence which is: Creative Commons Attribution 3.0 (further info:
-http://creativecommons.org/licenses/by/3.0/ )
+Info: please make sure that you understand all aspects due to Friendica's 
+default licence which is: MIT License (further info:
+https://github.com/friendica/friendica/blob/master/LICENSE)