chore: readme and documented functions