updates inline docs and README.md