modified readme and comment on fucntion