updated readme plus added in the generated docs