update documentation
increasing visibility of code in README