1aSmack README
2=============
3
4Version: $VERSION_TAG
5Build date: $BUILD_DATE
6
7Important Notes
8===============
9
10Read this, or aSmack won't work for you!
11
12Static Code
13-----------
14
15In order to work correctly on Android, you need to register Smack's
16XMPP Providers and Extensions manually and init some static code
17blocks before you doing any XMPP activty. Calling
18SmackAndroid.init(Context) (in org.jivesoftware.smack) will do this
19for you.
20
21ConnectionConfiguration
22-----------------------
23
24Please use the provided AndroidConnectionConfiguration class if
25possible to create a new connection.
26
27Compression
28-----------
29
30If you want compressed XMPP streams you have to add
31[jzlib-1.0.7](http://www.jcraft.com/jzlib/) to your project. Note that
32every version higher then 1.0.7 wont work.
33More Info: https://github.com/Flowdalic/smack/issues/12
34
35Problems / Debugging
36==============================
37
38aSmack Wiki
39-----------
40
41More information about XMPP File Transfers, SSL Certificates and other
42stuff related to aSmack can be found in the wiki:
43https://github.com/Flowdalic/asmack/wiki
44
45How to debug your problem
46-------------------------
47
48We always provide source zips. Attach them to the jar in your favorite
49IDE. Enable debugging mode with [BOSH|XMPP]Connection.DEBUG and
50config.setDebug. See also:
51http://www.igniterealtime.org/builds/smack/docs/latest/documentation/debugging.html
52
53Reporting a bug
54---------------
55
56Your issue should contain
571. a logcat
582. a server to reproduce
593. the code you are using (for FOSS project we'll accept reposituroy URLs)
60
61If you record a logcat and make sure to remove your credentials
62(usually a base64 block inside <auth></auth>).
63
64There is no guarantee that we will reply immediatly. But we will try
65to investigate the problem. Feel free to join ##smack @ freenode and
66ask for help (you may have to idle for some time before you get a
67reply).
68
69Component Revision Information for this Release
70===============================================
71
72