From 0b19c1b8effd556c0c1588bb1337e93f47ccd241 Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Tue, 3 Jan 2017 08:55:14 +0100 Subject: [PATCH] Update README and documentation --- README.md | 8 ++++---- documentation/overview.md | 14 ++++---------- 2 files changed, 8 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 483288ba8..f4026b3e1 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ Instructions how to use Smack in your Java or Android project are provided in th About ----- -[Smack] is an open source, cross-platform, easy to use, Java XMPP client library. +[Smack] is an open source, highly modular, easy to use, XMPP client library written in Java for JVMs and Android. 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 and XMPP allows you to easily exchange data, in various ways e.g. fire-and-forget, publish-subscribe, between human and non-human endpoints. +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, …). Confused? Have a look at the [Overview](documentation/overview.md). @@ -23,7 +23,7 @@ Bug Reporting Only a few users have access for for filling bugs in the tracker. New users should: -1. Read ["How to ask for help or report an issue"](https://github.com/igniterealtime/Smack/wiki/How-to-ask-for-help-or-report-an-issue) +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) 2. [Create a forums account](https://community.igniterealtime.org/login!input.jspa?registerOnly=true) (only e-mail is a requirement, you can skip all the other fields). 3. Login to the forum account 4. Press New in your toolbar and choose Discussion @@ -53,7 +53,7 @@ Resources - Nightly Builds: http://www.igniterealtime.org/downloads/nightly_smack.jsp - Nightly Javadoc: http://www.igniterealtime.org/builds/smack/dailybuilds/javadoc/ - Nightly Documentation: http://www.igniterealtime.org/builds/smack/dailybuilds/documentation/ -- User Forum: http://community.igniterealtime.org/community/support/smack_users +- User Forum: https://community.igniterealtime.org/community/support/smack-support - Dev Forum: http://community.igniterealtime.org/community/developers/smack - Maven Releases: https://oss.sonatype.org/content/repositories/releases/org/igniterealtime/smack/ - Maven Snapshots: https://oss.sonatype.org/content/repositories/snapshots/org/igniterealtime/smack/ diff --git a/documentation/overview.md b/documentation/overview.md index 360242415..79049183b 100644 --- a/documentation/overview.md +++ b/documentation/overview.md @@ -15,20 +15,14 @@ Smack Key Advantages AbstractXMPPConnection connection = new XMPPTCPConnection("mtucker", "password", "jabber.org"); connection.connect().login(); - Chat chat = ChatManager.getInstanceFor(connection) - .createChat("jsmith@jivesoftware.com", new MessageListener() { - @Override - public void processMessage(Chat chat, Message message) { - System.out.println("Received message: " + message); - } - }); - chat.sendMessage("Howdy!"); + Message message = new Message("jsmith@jivesoftware.com", "Howdy! How are you?"); + connection.sendStanza(message); ``` -* 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. +* Doesn't force you to code at the XMPP protocol 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. + * Open Source under the Apache License 2.0, which means you can incorporate Smack into your commercial or non-commercial applications. About XMPP ----------