[#15] Added a waffle ready button to readme
[#15] Started to update README
[#15] Updated docstrings and generated docs

- Hide user namespace
- Updates docstrings in all namespaces
- Generated new codox documentation to doc/
[#15] Fixed missplaced docstring
Merge pull request #20 from kardan/15/update-readme

15/update readme