update usage of module in readme and use markdown format

This pr update the usage of the module with class parameters in the readme. It also move it to the markdown format
Thanks