From 64b8cfe3dcd3ef8588ea5b92271f60ea0a72014c Mon Sep 17 00:00:00 2001 From: Jason Sipula Date: Sat, 15 Feb 2014 13:36:42 -0800 Subject: [PATCH] added basic markdown readme --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..43ba29cc3 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +Smack +===== + +[Smack] is an Open Source, cross-platform, easy to use Java XMPP client library. + +Communicate with XMPP servers to perform real-time collaboration, including instant messaging and group chat. + +Key Advantages : + - Extremely simple to use, yet powerful API. Sending a text message to a user can be accomplished in only a few lines of code: + + ```sh + Connection connection = new XMPPConnection("jabber.org"); + connection.connect(); + connection.login("mtucker", "password"); + Chat chat = connection.getChatManager().createChat("jsmith@jivesoftware.com", new MessageListener() { + + public void processMessage(Chat chat, Message message) { + System.out.println("Received message: " + message); + } + }); + chat.sendMessage("Howdy!"); + ``` + + - Doesn't force you to code at the packet level, as other libraries do. + Smack provides intelligent higher level constructs such as the Chat and Roster classes, which let you program more efficiently. + - Does not require that you're familiar with the XMPP XML format, or even that you're familiar with XML. + - Provides easy machine to machine communication. Smack lets you set any number of properties on each message, including properties that are Java objects. + - Open Source under the Apache License, which means you can incorporate Smack into your commercial or non-commercial applications. + +[Smack] is an Open Source [XMPP (Jabber)] client library for instant messaging and presence. +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. + +[Smack] - an [Ignite Realtime] community project. + +------- + +[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. + +[Smack]:http://www.igniterealtime.org/projects/smack/index.jsp +[Ignite Realtime]:http://www.igniterealtime.org +[XMPP (Jabber)]:http://xmpp.org/ \ No newline at end of file