Skip to content

Improve README formatting and structure #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dippp10-ally wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve README formatting and structure #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="docs/commands/optiqor-hori.jpg" alt="Optiqor" width="520">

Check warning on line 2 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (Optiqor)

Check warning on line 2 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (hori)

Check warning on line 2 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (optiqor)
</p>

<p align="center"><b>Detect. Fix. Prove.</b></p>
Expand All @@ -13,7 +13,7 @@
[![Downloads](https://img.shields.io/npm/dm/@optiqor/cli.svg)](https://www.npmjs.com/package/@optiqor/cli)

```sh
npx @optiqor/cli analyze ./my-helm-chart

Check warning on line 16 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (optiqor)
```

That is it. One command. No setup. No account. Cost findings for your Kubernetes workloads in under three seconds.
Expand All @@ -22,7 +22,7 @@

## Table of Contents

- [Why Optiqor CLI](#why-optiqor-cli)

Check warning on line 25 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (Optiqor)
- [Install](#install)
- [Quick Start](#quick-start)
- [How It Works](#how-it-works)
Expand All @@ -32,20 +32,20 @@
- [CLI vs Agent vs Sandbox](#cli-vs-agent-vs-sandbox)
- [Configuration](#configuration)
- [Privacy and Accuracy](#privacy-and-accuracy)
- [The Full Optiqor Platform](#the-full-optiqor-platform)

Check warning on line 35 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (Optiqor)
- [FAQ](#faq)
- [Contributing](#contributing)
- [License](#license)

---

## Why Optiqor CLI

Check warning on line 42 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (Optiqor)

Most Kubernetes cost tools require you to install an agent in your cluster, expose Prometheus, and wait 30 days for data. That is the right call for production teams who need exact numbers.

But sometimes you just want a directional answer **right now** about a chart you are reviewing.

The Optiqor CLI is a deterministic rule engine that reads your Helm chart files (or `values.yaml`) and reports cost inefficiencies in seconds. It runs fully offline. It does not phone home. It is honest about what it can and cannot tell from static files alone.

Check warning on line 48 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (Optiqor)

> [!TIP]
> **Bonus:** while it is parsing your chart for cost waste, it also flags the obvious Kubernetes security misconfigurations it sees (`runAsRoot`, `:latest` tags, missing `securityContext`, host namespaces, etc.). This is a side-effect of the parser — not the headline feature. If you need a real security posture tool, use one. If you happen to also catch them for free during a cost review, even better.
Expand All @@ -60,13 +60,13 @@
### Option 1: npx (zero-install, recommended for one-off use)

```sh
npx @optiqor/cli analyze ./chart

Check warning on line 63 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (optiqor)
```

### Option 2: Global npm install

```sh
npm install -g @optiqor/cli

Check warning on line 69 in README.md

View workflow job for this annotation

GitHub Actions / Spell check 

Unknown word (optiqor)
optiqor analyze ./chart
```

Expand Down Expand Up @@ -658,3 +658,30 @@
---

<sub>Optiqor is a product of Optiqor, Inc. Trademark and brand assets are not licensed under Apache 2.0.</sub>

## ✨ README Improvement Notes

### 📌 Formatting Enhancements Needed
- Improve heading hierarchy for better readability
- Ensure consistent spacing between sections
- Use proper Markdown formatting for code blocks and lists
- Align all installation and usage steps properly

### 🚀 Suggested Structure Upgrade
- Introduction
- Features
- Tech Stack
- Installation
- Usage
- Project Structure
- Contribution Guidelines
- License

### 🛠️ Documentation Improvements
- Add badges (optional): build, license, contributors
- Add screenshots for better UI understanding
- Standardize code blocks for commands

### 🎯 Goal
Improve onboarding experience for new contributors and users by making README more structured, readable, and professional.

Loading