Mercury-IM/Smack
Mercury-IM/Smack
1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-22 14:22:05 +01:00
Code Issues Releases Wiki Activity

Update documentation and README.md

Browse source
This commit is contained in:
Florian Schmaus 2015-03-13 16:27:50 +01:00
parent 24d2b0b0b9
commit e126469003
4 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -6,14 +6,10 @@ Smack
About About
----- -----
[Smack] is an Open Source, cross-platform, easy to use Java XMPP [Smack] is an open source, cross-platform, easy to use, Java XMPP client library.
client library.
[Smack] is an Open Source [XMPP (Jabber)] client library for instant A pure Java library, it can be embedded into your applications to create anything from a full XMPP client to simple XMPP integrations such as sending notification messages and presence-enabling devices.
messaging and presence. A pure Java library, it can be embedded into 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.
your applications to create anything from a full XMPP client to simple
XMPP integrations such as sending notification messages and
presence-enabling devices.
Confused? Have a look at the [Overview](documentation/overview.md). Confused? Have a look at the [Overview](documentation/overview.md).

5
documentation/developer/stanzas.md
View file

@ -4,12 +4,13 @@ General Rules
All classes which subclass `TopLevelStreamElement` and `ExtensionElement` must either All classes which subclass `TopLevelStreamElement` and `ExtensionElement` must either
1. be immutable (and ideally provide a Builder) 1. be immutable (and ideally provide a Builder)
2. implemented `TypedCloneable` 2. implement `TypedCloneable`
and must be `Serializable`. and must be `Serializable`.
The reason that it must be either 1. or 2. is that it makes no sense to clone an inmutable instance. The reason that it must be either 1. or 2. is that it makes no sense to clone an inmutable instance.
The preferred option is 1.
Note that there is legacy code in Smack which does not follow these rules. Patches welcome. Note that there is legacy code in Smack which does not follow these rules. Patches are welcome.
ExtensionElement ExtensionElement
================ ================

1
documentation/gettingstarted.md
View file

@ -14,6 +14,7 @@ library ships as several JAR files to provide more flexibility over which
features applications require: features applications require:
* `smack-core.jar` -- provides core XMPP functionality. All XMPP features that are part of the XMPP RFCs are included. * `smack-core.jar` -- provides core XMPP functionality. All XMPP features that are part of the XMPP RFCs are included.
* `smack-im.jar` -- provides functinoality defined in RFC 6121 (XMPP-IM), like the Roster.
* `smack-tcp.jar` -- support for XMPP over TCP. Includes XMPPTCPConnection class, which you usually want to use * `smack-tcp.jar` -- support for XMPP over TCP. Includes XMPPTCPConnection class, which you usually want to use
* `smack-extensions.jar` -- support for many of the extensions (XEPs) defined by the XMPP Standards Foundation, including multi-user chat, file transfer, user search, etc. The extensions are documented in the [extensions manual](extensions/index.md). * `smack-extensions.jar` -- support for many of the extensions (XEPs) defined by the XMPP Standards Foundation, including multi-user chat, file transfer, user search, etc. The extensions are documented in the [extensions manual](extensions/index.md).
* `smack-experimental.jar` -- support for experimental extensions (XEPs) defined by the XMPP Standards Foundation. The API and functionality of those extensions should be considered as unstable. * `smack-experimental.jar` -- support for experimental extensions (XEPs) defined by the XMPP Standards Foundation. The API and functionality of those extensions should be considered as unstable.

4
documentation/overview.md
View file

@ -17,7 +17,7 @@ Smack Key Advantages
Chat chat = ChatManager.getInstanceFor(connection) Chat chat = ChatManager.getInstanceFor(connection)
.createChat("jsmith@jivesoftware.com", new MessageListener() { .createChat("jsmith@jivesoftware.com", new MessageListener() {
@Override
public void processMessage(Chat chat, Message message) { public void processMessage(Chat chat, Message message) {
System.out.println("Received message: " + message); System.out.println("Received message: " + message);
} }
@ -35,7 +35,7 @@ About XMPP
XMPP (eXtensible Messaging and Presence Protocol) is an open protocol XMPP (eXtensible Messaging and Presence Protocol) is an open protocol
standardized by the IETF and supported and extended by the XMPP Standards standardized by the IETF and supported and extended by the XMPP Standards
Foundation (([http://www.xmpp.org](http://www.xmpp.org)). Foundation (XSF, [http://www.xmpp.org](http://www.xmpp.org)).
How To Use This Documentation How To Use This Documentation
----------------------------- -----------------------------