improve README of jappixmini addon

This commit is contained in:
Leberwurscht 2012-04-14 18:41:11 +02:00
parent af99d51a7c
commit 82cdd95ab8

View File

@ -4,14 +4,18 @@ Jappix Mini Plugin
This quick-and-dirty addon allows you to add a Jabber-based, Facebook-like chat This quick-and-dirty addon allows you to add a Jabber-based, Facebook-like chat
to Friendica. It uses Jappix Mini. to Friendica. It uses Jappix Mini.
It is necessary to use a BOSH proxy - so to use this plugin, you need to know the It is necessary to use a BOSH proxy - so to use this plugin, you need to know
address of a BOSH proxy that works with your account. the address of a BOSH proxy that works with your 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.
The addon has an experimental autosubscribe and autosuggest functionality which tries The addon has an experimental autosubscribe and autosuggest functionality which
to add your Friendica contacts to your roster automatically. tries to add your Friendica contacts to your roster automatically.
Limitations: Limitations:
- can only handle Jabber passwords that are at most 39 characters long - The addon can only handle Jabber passwords that are at most 39 characters
long.
Installation Installation
------------ ------------
@ -20,7 +24,7 @@ Jappix Mini (AGPL license) is not distributed with this addon. You need to
install it manually: install it manually:
* Download latest zip file named friendica-addon-* from * Download latest zip file named friendica-addon-* from
https://github.com/Leberwurscht/jappix/tags and place the zip file in the addon https://github.com/Leberwurscht/jappix/tags and place the zip file in the
folder. Make sure to name it 'jappix.zip' - the download link required by the AGPL addon folder. Make sure to name it 'jappix.zip' - the download link required
points there. by the AGPL points there.
* Unpack the zip file, rename the folder to 'jappix'. Do not delete jappix.zip. * Unpack the zip file, rename the folder to 'jappix'. Do not delete jappix.zip.