added more documentation about the API