added some documentation to the readme for display on github