Rethink documentation

[mateiidavid]

Problem

---

• Currently, the README.md file contains a long list of commands that have been added over time since the inception of the project. I think it would be clearer if we would separate the API documentation from the general functionality of this repo.
• The formatting in the README.md also makes it harder to distinguish between the different commands, we are also lacking examples and additional help for developers looking to use this specific pack as part of flyte.

Proposed changes

---

• First, I would like to see a docs/ directory added to the project. This issue would go hand in hand with Change package structure to look more like a Go project #20
• Clean out the README -- include badges, general description of the project (as well as a link to the main flyte repository), a link to a CHANGELOG, CONTRIBUTING and a link to the actual docs in docs/.