added some javadoc
the readme