add documentation notes to readmi