Improve README clarity and add workflow explanation

[bhavyamittal06]

This PR improves README clarity and adds a simple workflow explanation of the evolutionary optimization process to help new contributors better understand the project.

[qodo-code-review]

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

Review Summary by Qodo

Add workflow diagram and enhance README documentation

📝 Documentation

Walkthroughs

Description

• Removed bold formatting from caution notice for consistency
• Enhanced feature descriptions with concrete examples
• Added ASCII workflow diagram explaining evolutionary optimization process
• Minor formatting adjustments and whitespace cleanup

Diagram

flowchart LR
  A["Config Setup"] --> B["Generate Scenarios"]
  B --> C["Execute Chaos"]
  C --> D["Evaluate Fitness"]
  D --> E["Evolve & Iterate"]
  E -.-> B

Loading

File Changes

1. README.md 📝 Documentation +18/-5

Enhanced documentation with workflow diagram and examples

• Removed bold formatting from caution notice text
• Added concrete examples to feature descriptions (pod termination race condition, SLO violations)
• Inserted ASCII text-based workflow diagram showing the evolutionary optimization process flow
• Fixed minor formatting inconsistencies and extra whitespace

README.md

---

[qodo-code-review]

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. Trailing whitespace fails pre-commit 🐞 Bug ⛯ Reliability

Description

README.md contains trailing spaces that will be rewritten by the trailing-whitespace pre-commit
hook; because CI runs pre-commit on changed files, this will fail the CI job until the whitespace is
removed. This can block merging even though it’s “just docs.”

Code

README.md[9]

+An intelligent chaos engineering framework that uses genetic algorithms to optimize chaos scenarios for Kubernetes/OpenShift applications. Krkn-AI automatically evolves and discovers the most effective chaos experiments to test your system's resilience. 

Evidence

CI runs pre-commit run --from-ref origin/main --to-ref HEAD on PR changes, and pre-commit is
configured to enforce trailing-whitespace. The README now has trailing whitespace on at least two
changed lines, so the hook will modify README.md and CI will fail.

.github/workflows/ci.yml[41-46]
.pre-commit-config.yaml[19-25]
README.md[9-9]
README.md[308-308]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`README.md` has trailing whitespace on newly edited lines. The `trailing-whitespace` pre-commit hook will rewrite the file, and CI runs pre-commit on changed files, so the workflow will fail until the whitespace is removed.

### Issue Context
CI runs `pre-commit run --from-ref origin/main --to-ref HEAD` and `.pre-commit-config.yaml` enables `trailing-whitespace`.

### Fix Focus Areas
- README.md[9-9]
- README.md[308-308]
- .pre-commit-config.yaml[19-25]
- .github/workflows/ci.yml[41-46]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

2. Markdown bullet/style issues 🐞 Bug ✓ Correctness

Description

In the Features list, the first item uses a nonstandard list marker formatting (-**...) which can
render inconsistently across Markdown processors and is inconsistent with other bullets in the
README. Another bullet is missing a space after a comma, reducing readability.

Code

README.md[R13-17]

+-**Genetic Algorithm Optimization**: Automatically evolves chaos scenarios to find optimal testing strategies, Discovers that terminating pods in a specific sequence reveals a race condition.
- **Multi-Scenario Support**: Pod failures, container scenarios, node resource exhaustion, and application outages
- **Kubernetes/OpenShift Integration**: Native support for both platforms
- **Health Monitoring**: Continuous monitoring of application health during chaos experiments
-- **Prometheus Integration**: Metrics-driven fitness evaluation
+- **Prometheus Integration**: Metrics-driven fitness evaluation,scenarios that trigger SLO violations get higher fitness scores.

Evidence

The Features section shows the first bullet formatted differently than the rest of the list (no
space after -), and the Prometheus bullet has evaluation,scenarios without a space after the
comma.

README.md[13-17]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The README Features list has inconsistent/possibly non-portable Markdown formatting for the first bullet (`-**...`) and a comma-spacing typo (`evaluation,scenarios`).

### Issue Context
Other bullets in the same section use the conventional `- **...**` formatting.

### Fix Focus Areas
- README.md[13-17]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

ⓘ The new review experience is currently in Beta. Learn more

[qodo-code-review]

1. Trailing whitespace fails pre-commit 🐞 Bug ⛯ Reliability

README.md contains trailing spaces that will be rewritten by the trailing-whitespace pre-commit
hook; because CI runs pre-commit on changed files, this will fail the CI job until the whitespace is
removed. This can block merging even though it’s “just docs.”

Agent Prompt

### Issue description
`README.md` has trailing whitespace on newly edited lines. The `trailing-whitespace` pre-commit hook will rewrite the file, and CI runs pre-commit on changed files, so the workflow will fail until the whitespace is removed.

### Issue Context
CI runs `pre-commit run --from-ref origin/main --to-ref HEAD` and `.pre-commit-config.yaml` enables `trailing-whitespace`.

### Fix Focus Areas
- README.md[9-9]
- README.md[308-308]
- .pre-commit-config.yaml[19-25]
- .github/workflows/ci.yml[41-46]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

[Jatinbhardwaj-093]

This information isn’t necessary for a quick-look guide. It’s better to keep it short and precise.

[Jatinbhardwaj-093]

I don’t see the need to reiterate the README and developer guides. They should remain short and precise.
Instead, it would be better to focus on expanding the documentation to provide more detailed explanations of features and functionality.