From 0f776705fb38a7bd05b5cac46f59203530e3ed62 Mon Sep 17 00:00:00 2001
From: Guillermo Dev <public.guillermo@gmail.com>
Date: Sat, 13 Oct 2018 22:23:01 +0200
Subject: [PATCH] added some basic description

---
 .README.md.swp | Bin 12288 -> 0 bytes
 README.md      |  33 +++++++++++++++++++++++++++++++--
 2 files changed, 31 insertions(+), 2 deletions(-)
 delete mode 100644 .README.md.swp

diff --git a/.README.md.swp b/.README.md.swp
deleted file mode 100644
index 9817a7faedb6f52a443711f32ae252e8df9646f1..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 12288
zcmeI&O=}b}7zglF@aPNm3q0D3LY?fcC|VHNcB^<OLRagdc*soRPG}~HNv35l`aL{)
z6Z{4qycO!_(Yu-1t%8Rly-4972${T0=E?6i<S7Sx&v)oyF=V-1XDogDx_|uT6I=bv
z*sL4-hti0u)>ak9Rl=OH{{4(Ub8cqT-AT}gif=hSF2zjoBUMHf4t1sY?)G@Hvt2au
zjD0W#0SKH&;0n7p8V<TQ*KXaU8>_F*vkBgT00bZa0SG_<0uX=z1TLsR@+<5^j{VXy
z{>#gD<*#<xMFRl{KmY;|fB*y_009U<00Izzzy%Z#`J(;fRmQ&O+TH)3{{R2H#@LTs
zH*+25+RdMIYfvBn0SG_<0uX=z1Rwwb2tWV=|5f0r3)HxvNZYqAG$Ltd*U1|tqN2*#
z*qTJC?&gyURv415Y8z!!zmztpPRVa@K72GPh7WQ|d@;H|;L;tmNBThb4~4J&6D=SA
zNmys>WvwFx<z3Xtg?aa>B(#nFw<;$U<#77WYgJAcY3|fUC4UEE<|G!O?Qc$Z-`rlt
zQR>oYmm_}Hs_1M!T2a;f4wdtMw@GMyK13IaPKtz;ROZ!-BfgmS17j<L(~^YuMpykg
OW08}8X_016YwQ;kGLrWI

diff --git a/README.md b/README.md
index 5268aaa..f93d394 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,34 @@
 # README #
 
-This repository contains the code for the WebService used internally at the [BSR](http://bibliothequesonore.ch/) by the Drupal website and both the iOS and Android applications.
+This repository contains the code for the WebService used internally at the 
+[BSR](http://bibliothequesonore.ch/) by the Drupal website and both the iOS 
+and Android applications.
 
-For more information, please consult the internal documentation : http://192.168.1.250/dokuwiki/doku.php?id=webservice
\ No newline at end of file
+For more information, please consult the internal documentation : 
+http://192.168.1.250/dokuwiki/doku.php?id=webservice
+
+BSR Webservice
+==============
+
+The webservice module contains a few classes that help implementing a webservice
+by simply inheritting from the abstract \BSR\Webservice
+
+When you subclass \BSR\Webservice, you can instantiate and call run() from an http 
+reachable file, such as index.php. From there, \BSR\Webservice will try to respond
+to the request that should contain a 'func'=<something> paramter which represnts the
+method being called by the webservice. You have to pass along the parameters of that
+method.
+
+BSR Renderer
+------------
+It uses a \BSR\Renderer to capture the buffer that will end up being returned as a
+response.
+
+BSR Formatter
+-------------
+Before the response is returned, it can be formatterd in one of : HTML, Json, Xml
+Text etc.
+
+For the moment the Formatter will always be of type Json, because it is hardcoded
+into the getFormatterFromHeaders() method. So if you are interested in any other
+formatter, modify that function.