readme updated to reflect optional required parameter