add documentation to the "public" methods and adapt the readme file
add documentation to the "public" methods and adapt the readme file