Write a complete documentation of the framework usage with code samples

[aneveux]

Complete the README file with a nice and clear documentation containing examples of each feature provided by the framework.

All API methods should be illustrated in that documentation.