added javadoc into readme