Merge pull request #950 from nupplaphil/bug/8182_another_notification_bug

[friendica-addons.git] / jappixmini / README

diff --git a/jappixmini/README b/jappixmini/README
index 822f4391cbe4bc0e8184111ca16895a20b22a7a6..0343d060b27deaf59667a486a98ee13df876ae1d 100644 (file)
--- a/jappixmini/README
+++ b/jappixmini/README
@@ -1,17 +1,18 @@
-Jappix Mini Plugin
+Jappix Mini Addon

 ==================
 
 This quick-and-dirty addon allows you to add a Jabber-based, Facebook-like chat
 to Friendica. It uses Jappix Mini.
 
 ==================
 
 This quick-and-dirty addon allows you to add a Jabber-based, Facebook-like chat
 to Friendica. It uses Jappix Mini.
 

-It is necessary to use a BOSH host - so to use this plugin, each users need to
+It is necessary to use a BOSH host - so to use this addon, each users need to

 know the address of a BOSH host that works with his account. The BOSH server of
 the Jappix project (https://bind.jappix.com/) is not locked to a specific XMPP
 provider, but keep in mind that only personal usage is approved according to
 http://codingteam.net/project/jappix/doc/BoshServer.
 If you have a larger server, it is recommended that you install your own BOSH
 know the address of a BOSH host that works with his account. The BOSH server of
 the Jappix project (https://bind.jappix.com/) is not locked to a specific XMPP
 provider, but keep in mind that only personal usage is approved according to
 http://codingteam.net/project/jappix/doc/BoshServer.
 If you have a larger server, it is recommended that you install your own BOSH

-server, add it to the <bosh> tag in jappix/store/conf/hosts.xml, and disable
-the bosh proxy in jappix/store/conf/main.xml.
+server and recommend it using the configuration help field. If it is on the
+same server, you can also deactivate the BOSH proxy. This should improve the
+performance.

 
 The addon has an experimental autosubscribe and autosuggest functionality which
 tries to add your Friendica contacts to your roster automatically.
 
 The addon has an experimental autosubscribe and autosuggest functionality which
 tries to add your Friendica contacts to your roster automatically.


@@ -20,14 +21,11 @@ Limitations:
  - Jabber passwords can only be encrypted if they are at most 39 characters
    long.
 
  - Jabber passwords can only be encrypted if they are at most 39 characters
    long.
 

-Installation
-------------
+Notes on the license
+--------------------

 
 

-Jappix Mini (AGPL license) is not distributed with this addon. You need to
-install it manually:
-
-* Download latest zip file named friendica-addon-* from
-  https://github.com/Leberwurscht/jappix/tags and place the zip file in the
-  addon folder. Make sure to name it 'jappix.zip' - the download link required
-  by the AGPL points there.
-* Unpack the zip file, rename the folder to 'jappix'. Do not delete jappix.zip.
+The license of this addon is AGPL, as required by Jappix Mini. If you make
+modifications to the addon, you are responsible for providing a proper facility
+for downloading the changed source code.
+Moreover, it may be necessary that you publish the source code of the Friendica
+application and all other used addons if you do not use standard versions.