From 85e2e14c818d6d5a7995d87918e267089bee7d9b Mon Sep 17 00:00:00 2001
From: Julien Fontanet <julien.fontanet@isonoe.net>
Date: Wed, 11 Feb 2015 14:11:10 +0100
Subject: [PATCH] README update.

---
 packages/xo-lib/README.md | 115 +++++++++++++++++++++++++++++++++++---
 1 file changed, 106 insertions(+), 9 deletions(-)

diff --git a/packages/xo-lib/README.md b/packages/xo-lib/README.md
index 7b0424d31..0f735d982 100644
--- a/packages/xo-lib/README.md
+++ b/packages/xo-lib/README.md
@@ -19,25 +19,122 @@ npm install --save xo-lib
 Then require the package:
 
 ```javascript
-var Xo = require('xo-lib');
+var xoLib = require('xo-lib');
 ```
 
-## Usage
+## High level API
+
+This high-level interface handles session sign-in and a cache of
+remote XO objects. It also automatically reconnect and retry method
+calls when necessary.
 
 ```javascript
-var Xo = require('xo-lib');
+var xo = new xoLib.Xo({
+  url: 'https://xo.company.tld',
+  auth: {
+    email: 'admin@admin.net',
+    password: 'admin',
+  },
+});
+```
 
-var xo = new Xo('https://xo.company.tld/api/');
+> If the URL is not provided and the current environment is a web
+> browser, the location of the current page will be used.
 
-xo.call('session.signInWithPassword', {
+### Method call
+
+```javascript
+xo.call('token.create').then(function (token) {
+  console.log('Token created', token);
+});
+```
+
+### Status
+
+The connection status is available through the status property which
+is *disconnected*, *connecting* or *connected*.
+
+```javascript
+console.log('%s to xo-server', xo.status);
+```
+
+### Current user
+
+Information about the user account used to sign in is available
+through the `user` property.
+
+```javascript
+console.log('Current user is', xo.user);
+```
+
+> This property is null when the status is not connected.
+
+
+### XO Objects
+
+XO objects are cached locally in the `objects` collection.
+
+```javascript
+// Get an object for a specific id.
+var obj = xo.objects.get(id);
+
+// Get all VMs.
+var vms = xo.objects.where('type', 'VM');
+```
+
+## Low level
+
+```javascript
+var api = new xoLib.Api('https://xo.company.tld');
+```
+
+> If the URL is not provided and the current environment is a web
+> browser, the location of the current page will be used.
+
+### Connection
+
+```javascript
+api.connect().then(function () {
+  console.log('connected');
+});
+```
+
+### Disconnection
+
+```javascript
+api.close();
+```
+
+### Method call
+
+```javascript
+api.call('session.signInWithPassword', {
   email: 'admin@admin.net',
   password: 'admin',
-}).then(function () {
-  return xo.call('session.getUser');
 }).then(function (user) {
-  console.log(user);
+  console.log('Connected as', user);
+});
+```
 
-  xo.close();
+> A method call automatically trigger a connection if necessary.
+
+### Events
+
+```javascript
+api.on('connected', function () {
+  console.log('connected');
+});
+```
+
+```javascript
+api.on('disconnected', function () {
+  console.log('disconnected');
+});
+```
+
+```javascript
+api.on('notification', function (notif) {
+  console.log('notification:', notif.method, notif.params);
 });
 ```