From 9db104799b43cc36ddd945ac1881d1a654fa13bc Mon Sep 17 00:00:00 2001
From: Matthieu Lalonde <matth_web_git@lalonde.me>
Date: Wed, 4 Aug 2010 23:45:06 +0200
Subject: [PATCH] basic doc

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b44e98d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+XMPP Client for node
+====================
+
+Node-xmpp is a cute but low level tool, so, here is xmpp client.
+
+Install
+-------
+
+    npm install xmpp
+
+Tests
+-----
+    npm install colors
+    npm install nodeunit
+
+You have to edit a new file in `test/conf.js` :
+
+    exports.conf = {
+      a: {
+        jid: 'andre@gmail.com',
+        password: '42'
+      },
+      b: {
+        jid: 'bob@jabber.org',
+        password: 'beuha'
+      }
+    }
+
+Then, you can launch test :
+
+    node test/test.js