added comments, made use of logger config functions clearer, return types. TODO need to check scaladoc and markdown syntax
fixed readme markdown
fix up scaladoc