Develop

[simasgrilo]

Tl;dr

README rewriting to better display the project - fix for approved PR #27 as the image had a reference path for Windows, not Unix.

Context

This change adds more context to what exaclty the project does, as well as the dependencies and how the architecture is done. I have added the following sections:

• Stack used: all main components and their versions.
• Architecture: the high level design on how the log aggregator works in a Kubernetes-first environment.
• Features: Adds a bullet-list of features that the current solution has
• Getting Started: step-by-step on how to run locally in a Kubernetes cluster.

Test Plan

N/A

Links

N/A

Checklist

• Pull request title is succinct with [tiny] if it’s extra small
• Describes the problem
• Describes the solution (screenshots included if UI changes)
• Has a test plan
• Contains links to any context (Slack, Figma, JIRA ticket, etc.)
• Code is self reviewed for readability, approach, and edge cases
• Lines changed that may require additional explanation are annotated with an explanation
• Change is ideally < 500 lines if possible. < 150 is ideal.