Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updated README.

  • Loading branch information...
commit ff7745f77e4b1e84780254db33473c8e575790e0 1 parent 16985d9
Tim Evans authored
Showing with 17 additions and 16 deletions.
  1. +17 −16 README.md
View
33 README.md
@@ -1,7 +1,7 @@
XC: XMMP Client Library
=======================
-The XC Library is an [RFC 3920](http://xmpp.org/rfcs/rfc3920.html) and [RFC 3921](http://xmpp.org/rfcs/rfc3921.html) compliant XMPP Client library for JavaScript. In addition to the XMPP Core and XMPP IM specs, we also implement [Service Discovery](http://xmpp.org/extensions/xep-0030.html), [Chat State Notifications](http://xmpp.org/extensions/xep-0085.html), [vCards](http://xmpp.org/extensions/xep-0054.html), [Delayed Delivery](http://xmpp.org/extensions/xep-0203.html), and [Roster Item Exchange](http://xmpp.org/extensions/xep-0144.html).
+The XC Library is an [RFC 3920](http://xmpp.org/rfcs/rfc3920.html) and [RFC 3921](http://xmpp.org/rfcs/rfc3921.html) compliant XMPP Client library for JavaScript. In addition to the XMPP Core and XMPP IM specs, we also implement [Service Discovery](http://xmpp.org/extensions/xep-0030.html), [Chat State Notifications](http://xmpp.org/extensions/xep-0085.html), [vCards](http://xmpp.org/extensions/xep-0054.html), [Delayed Delivery](http://xmpp.org/extensions/xep-0203.html), [Private XML Storage](http://xmpp.org/extensions/xep-0049.html) and [Roster Item Exchange](http://xmpp.org/extensions/xep-0144.html).
Getting Started
---------------
@@ -73,26 +73,27 @@ FUTURE
------
We have some ideas on making the library more extensible, since this version is quite rigid.
+
This includes instead of parsing out values into JSON, returning objects that include the DOM node of the XMPP stanza and a list of XPaths for known elements that can be parsed out, this will allow the client library to lazily retrieve.
For example:
receive XML:
- <message type='chat'>
- <body>Hi There</body>
- <foo xmlns="urn:foobar"><bar>value</bar></foo>
- </message>
+ <message type='chat'>
+ <body>Hi There</body>
+ <foo xmlns="urn:foobar"><bar>value</bar></foo>
+ </message>
creates object =>
- msg = {
- doc: <a dom document>
- xpaths: {
- type: '/message/@type',
- body: '/message/body',
- foobar:foo: '/message/foo',
- foobar:bar: '/message/foo/bar'
- }
- }
-
-Combining this with a delivery system that emphasizes pattern matching / condition mapping instead of brittle pre-baked event listeners, we can design a library that is lighter and minimal.
+ msg = {
+ doc: <a dom document>
+ xpaths: {
+ type: '/message/@type',
+ body: '/message/body',
+ foobar:foo: '/message/foo',
+ foobar:bar: '/message/foo/bar'
+ }
+ }
+
+Combining this with a delivery system that emphasizes pattern matching / condition mapping instead of brittle pre-baked event listeners, we can design a lighter and more extensible library.
Please sign in to comment.
Something went wrong with that request. Please try again.