initial import
update readme for example usage
add optional parameters to documentation