2014-02-15 22:36:42 +01:00
Smack
=====
2016-01-15 14:45:40 +01:00
[![Build Status ](https://travis-ci.org/igniterealtime/Smack.svg?branch=master )](https://travis-ci.org/igniterealtime/Smack) [![Coverage Status ](https://coveralls.io/repos/igniterealtime/Smack/badge.svg )](https://coveralls.io/r/igniterealtime/Smack) [![Project Stats ](https://www.openhub.net/p/smackxmpp/widgets/project_thin_badge.gif )](https://www.openhub.net/p/smackxmpp) [![Flattr this git repo ](http://api.flattr.com/button/flattr-badge-large.png )](https://flattr.com/thing/3480125) [![Visit our IRC channel ](https://kiwiirc.com/buttons/irc.freenode.net/smack.png )](https://kiwiirc.com/client/irc.freenode.net/smack)
2014-06-14 18:42:55 +02:00
2014-02-18 10:03:42 +01:00
About
-----
2014-02-15 22:36:42 +01:00
2017-03-10 21:39:01 +01:00
[Smack] is an open source, highly modular, easy to use, XMPP client library written in Java for Java SE compatible JVMs and Android.
2015-03-13 16:27:50 +01:00
2017-03-10 21:39:01 +01:00
A pure Java library, it can be embedded into your applications to create anything from a full XMPP instant messaging client to simple XMPP integrations such as sending notification messages and presence-enabling devices.
2017-01-03 08:55:14 +01:00
Smack and XMPP allows you to easily exchange data, in various ways e.g. fire-and-forget, publish-subscribe, between human and non-human endpoints (M2M, IoT, …).
2014-02-15 22:36:42 +01:00
2017-04-09 13:09:14 +02:00
More information are provided by the [Overview ](documentation/overview.md ).
2014-02-15 22:36:42 +01:00
2017-03-10 21:39:01 +01:00
Getting started
---------------
2017-09-15 22:28:30 +02:00
Start with having a look at the ** [Documentation]** and the ** [Javadoc]**.
2017-04-09 13:09:14 +02:00
2017-03-10 21:39:01 +01:00
Instructions how to use Smack in your Java or Android project are provided in the [Smack 4.2 Readme and Upgrade Guide ](https://github.com/igniterealtime/Smack/wiki/Smack-4.2-Readme-and-Upgrade-Guide ).
2014-02-18 10:03:42 +01:00
Bug Reporting
-------------
2014-10-19 11:51:53 +02:00
Only a few users have access for for filling bugs in the tracker. New
2014-02-18 10:03:42 +01:00
users should:
2017-01-03 08:55:14 +01:00
1. Read ["How to ask for help or report an issue" ](https://github.com/igniterealtime/Smack/wiki/How-to-ask-for-help,-report-an-issue-and-possible-solve-the-problem-yourself )
2017-10-29 01:49:46 +02:00
2. [Create a discourse account ](https://discourse.igniterealtime.org/signup ) (you can also sign up with your google account).
2015-03-13 11:30:26 +01:00
3. Login to the forum account
4. Press New in your toolbar and choose Discussion
2017-10-29 01:49:46 +02:00
5. Choose the [Smack Users Forum] and add the tag 'Smack Support' to your new post
2014-02-18 10:03:42 +01:00
Please search for your issues in the bug tracker before reporting.
Contact
-------
2014-10-19 11:51:53 +02:00
The developers hang around in `#smack` (freenode, IRC) and `open_chat@conference.igniterealtime.org` (XMPP MUC room).
2014-09-05 11:58:18 +02:00
Remember that it may take some time (~hours) to get a response.
2014-02-18 10:03:42 +01:00
2014-09-05 11:58:18 +02:00
You can also reach us via the [Smack Users Forum] if you have questions or need support, or the [Smack Developers Forum] if you want to discuss Smack development.
2014-02-18 10:03:42 +01:00
2015-03-13 11:30:26 +01:00
Contributing
------------
If you want to start developing for Smack and eventually contribute code back, then please have a look at the [Guidelines for Smack Developers and Contributors ](https://github.com/igniterealtime/Smack/wiki/Guidelines-for-Smack-Developers-and-Contributors ).
The guidelines also contain development quickstart instructions.
2014-02-16 15:22:47 +01:00
Resources
---------
2017-03-10 21:39:01 +01:00
- Bug Tracker: https://issues.igniterealtime.org/browse/SMACK
2015-03-13 11:30:26 +01:00
- JaCoCo Coverage Reports: https://www.igniterealtime.org/builds/smack/dailybuilds/jacoco/html/
2014-02-16 15:22:47 +01:00
- Nightly Builds: http://www.igniterealtime.org/downloads/nightly_smack.jsp
2014-03-10 10:23:33 +01:00
- Nightly Javadoc: http://www.igniterealtime.org/builds/smack/dailybuilds/javadoc/
- Nightly Documentation: http://www.igniterealtime.org/builds/smack/dailybuilds/documentation/
2017-10-29 01:49:46 +02:00
- User Forum: https://discourse.igniterealtime.org/c/smack/smack-support
- Dev Forum: https://discourse.igniterealtime.org/c/smack/smack-dev
2014-05-25 11:01:52 +02:00
- Maven Releases: https://oss.sonatype.org/content/repositories/releases/org/igniterealtime/smack/
- Maven Snapshots: https://oss.sonatype.org/content/repositories/snapshots/org/igniterealtime/smack/
2017-03-10 21:39:01 +01:00
- Nightly Unique Maven Snapshots: https://igniterealtime.org/repo/
2014-02-16 15:22:47 +01:00
2014-09-10 12:21:05 +02:00
Donate
------
If you find Smack useful and feel like donating, then you can use one of the following systems:
2017-08-12 12:37:09 +02:00
- Donate via Bitcoin: 1LiU78z3498wu3jwRPKbvovKAHjTcpVbuK
2014-09-27 17:18:19 +02:00
- [Donate via Flattr ](https://flattr.com/thing/3480125 )
2014-09-10 12:21:05 +02:00
2014-02-16 15:22:47 +01:00
Ignite Realtime
===============
2014-02-15 22:36:42 +01:00
[Ignite Realtime] is an Open Source community composed of end-users and developers around the world who
are interested in applying innovative, open-standards-based Real Time Collaboration to their businesses and organizations.
We're aimed at disrupting proprietary, non-open standards-based systems and invite you to participate in what's already one
of the biggest and most active Open Source communities.
2017-04-09 13:09:14 +02:00
[Smack] - an [Ignite Realtime] community project.
2017-10-29 01:49:46 +02:00
[Smack]: https://www.igniterealtime.org/projects/smack/index.jsp
2014-02-16 15:22:47 +01:00
[Ignite Realtime]: http://www.igniterealtime.org
[XMPP (Jabber)]: http://xmpp.org/
2017-10-29 01:49:46 +02:00
[Smack Developers Forum]: https://discourse.igniterealtime.org/c/smack/smack-dev
[Smack Users Forum]: https://discourse.igniterealtime.org/c/smack/smack-support
2017-09-15 22:28:30 +02:00
[Documentation]: https://download.igniterealtime.org/smack/docs/latest/documentation/
2017-04-09 13:09:14 +02:00
[Javadoc]: https://download.igniterealtime.org/smack/docs/latest/javadoc/