Update devfile library readme

Recently some PRs have been merged into devfile library which expect different input/behavior as previous library. For instance, this issue: https://github.com/devfile/api/issues/369

The library readme file should be updated accordingly. 

In addition, we expect the library documentation to be more detailed and understandable to RedHat external users. 