update READMEs

Signed-off-by: Chris “Kwpolska” Warrick <kwpolska@gmail.com>
add a docstring

Signed-off-by: Chris “Kwpolska” Warrick <kwpolska@gmail.com>