updates to readme and added javadocs