diff --git a/README.md b/README.md index db2a78b..5467807 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,12 @@ A basic module for IM using the Jabber/XMPP protocol with PLT Scheme. Should eventually implement XMPP-Core and XMPP-IM to conform with RFCs 3920 and 3921. Progress toward supporting the full protocol is currently documented in the file 'xmpp.scm' + +## Installation + + (require (planet "xmpp.scm" (zzkt gibberish 1 0))) -## example chat client +## Example Chat Client (require xmpp) @@ -28,6 +32,7 @@ currently documented in the file 'xmpp.scm' (send (message to msg)) (loop)))))) + ## possiby interesting extensions to implement. see http://xmpp.org/extensions/ diff --git a/gibebrish.scrbl b/gibberish.scrbl similarity index 65% rename from gibebrish.scrbl rename to gibberish.scrbl index 7cbea64..dbd076a 100644 --- a/gibebrish.scrbl +++ b/gibberish.scrbl @@ -3,7 +3,22 @@ @title{Gibberish} -@title{Example chat client} +Gibberish is a module for using the Jabber/XMPP protocol. + +@table-of-contents[] + +@section{Protocol Support} + +It should eventually implement XMPP-Core and XMPP-IM to conform with +RFCs 3920 and 3921. Progress toward supporting the full protocol is +currently documented in the file 'xmpp.scm' + +@section{Installation} + +(require (planet "xmpp.scm" (zzkt gibberish 1 0))) + + +@section{Example Chat Client} @schemeblock[ @@ -13,7 +28,7 @@ (display prompt) (read-line (current-input-port))) - (define (chat2) + (define (chat) (let ((jid (read-input "jid: ")) (pass (read-input "password: ")) (to (read-input "chat with: "))) @@ -25,4 +40,4 @@ (loop)))))) ] - +and chat away... diff --git a/info.ss b/info.ss index 13fa154..1454590 100644 --- a/info.ss +++ b/info.ss @@ -1,20 +1,29 @@ #lang setup/infotab -;; http://docs.plt-scheme.org/planet/Developing_Packages_for_PLaneT.html -(define name "gibberish") +(define name + "gibberish") -(define 'blurb "A client library for the XMPP or Jabber protocol.") +(define blurb + '("A client library for the XMPP or Jabber protocol.")) -(define 'release-notes "") +(define categories + '(xml net)) -(define 'categories '(xml net)) +(define homepage + "http://github.com/zzkt/gibberish/") -(define 'homepage "") +(define primary-file + "xmpp.ss") -(define 'primary-file "xmpp.scm") - -(define 'repositories "4.x") +(define repositories + '("4.x")) -(define 'required-core-version "4.1.5") +(define required-core-version + "4.1.5") + +(define release-notes + '("")) + +;(define scribblings +; '(("gibberish.scrbl" ()))) -(define scribblings '("gibberish.scrbl" ())) diff --git a/xmpp.scm b/xmpp.ss similarity index 99% rename from xmpp.scm rename to xmpp.ss index abe6bfa..b749ea1 100644 --- a/xmpp.scm +++ b/xmpp.ss @@ -53,6 +53,7 @@ ;;; - rfc 3921 ;;; ;;; bugs and/or improvements +;;; - PLaneT installable ;;; - read-async & repsonse-handler ;;; - ssax:xml->sxml or lazy:xml->sxml ;;; - default handlers @@ -284,7 +285,7 @@ ,@body (close-output-port out) (close-input-port in)))) - + ) ;; end module