From 03ec46cd2f23c5855db231a6bcb5e645fd5bc2d0 Mon Sep 17 00:00:00 2001 From: Jon Kristensen Date: Sat, 1 Jun 2013 14:22:47 +0200 Subject: [PATCH] README.md: Clarifications, mention ICU dependency, and conform to API --- README.md | 34 ++++++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 90516b5..30bfd2c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ Welcome to Pontarius XMPP! ========================== -Pontarius XMPP is an active work in progress to build a Haskell XMPP library -that implements the client capabilities of [RFC 6120](http://tools.ietf.org/html/rfc6120). +Pontarius XMPP is an active work in progress to build a Haskell XMPP client +library that implements the capabilities of [RFC 6120 +("XMPP CORE")](http://tools.ietf.org/html/rfc6120), [RFC 6121 ("XMPP +IM")](http://tools.ietf.org/html/rfc6121), and [RFC 6122 ("XMPP +ADDR")](http://tools.ietf.org/html/rfc6122). Pontarius XMPP is part of [the +Pontarius project](http://www.pontarius.org/), an effort to produce free and +open source, uncentralized, and privacy-aware software solutions. Getting started --------------- @@ -14,6 +19,10 @@ page](http://hackage.haskell.org/package/pontarius-xmpp/). _Note:_ Pontarius XMPP is still in its Alpha phase. Pontarius XMPP is not yet feature-complete, it may contain bugs, and its API may change between versions. +_Note:_ You will need the ICU Unicode library and it's header files in order to +be able to build Pontarius XMPP. On Debian, you will need to install the +*libicu-dev* package. In Fedora, the package is called *libicu-devel*. + The first thing to do is to import the modules that we are going to use. We are also using the OverloadedStrings LANGUAGE pragma in order to be able to type Text values like strings. @@ -36,15 +45,16 @@ When this is done, a Session object can be acquired by calling result <- session "example.com" + (Just (\_ -> ( [scramSha1 "username" Nothing "password"]) + , Nothing)) def - (Just ([scramSha1 "username" Nothing "password"], Nothing)) -The three parameters above are the XMPP server realm, the session configuration -settings (set to the default settings), and a SASL handler (for authentication). -session will perform the necessary DNS queries to find the address -of the realm, connect, establish the XMPP stream, attempt to secure the stream -with TLS, authenticate, establish a concurrent interface for interacting with -the stream, and return the Session object. +The three parameters above are the XMPP server realm, a SASL handler (for +authentication), and the session configuration settings (set to the default +settings). session will perform the necessary DNS queries to find +the address of the realm, connect, establish the XMPP stream, attempt to secure +the stream with TLS, authenticate, establish a concurrent interface for +interacting with the stream, and return the Session object. The return type of session is IO (Either XmppFailure Session). As XmppFailure is an @@ -58,7 +68,11 @@ doing it could be doing something like this: Next, let us set our status to Online. - sendPresence (Presence Nothing Nothing Nothing Nothing Nothing []) sess + sendPresence def sess + +Here, def refers to the default Presence value, which +is the same as Presence Nothing Nothing Nothing Nothing Available +[]. Now, let's say that we want to receive all message stanzas, and echo the stanzas back to the recipient. This can be done like so: