README.md has been updated
API documentation has been added to the interface file