Update the readme.md
Add javaDoc comments to the typescript file.