Currently the README doesn't provide much info on what problems the project solves and how to use it. We need to rewrite it to align with OSS style: https://github.com/dbader/readme-template

Additionally, we need a more detailed design doc to describe its architecture, and especially its interfaces for external systems to integrate.