added readme and updated doc-strings