feat: add readme md
Description
- add readme and guide instructions
Related Links
Type of change
-
Fix bugs in test / code -
New feature -
Docs -
Refactor -
Other: please elaborate
How have I tested this
-
I have covered the code with unit tests -
I have performed manual testing
Risks
-
low: new features or patches which does not break existing functionality -
medium: existing functionality in our domain is changed, but does not break contracts with other domain -
high: breaking contracts with other domain
Checklist:
-
Any technical debt is marked with // TODO: <debt details> -
My code follows the code style of this project.