updated readme with initial function prototype