From 8796abd888e2b6585e591cf2c0d41c7d843814d1 Mon Sep 17 00:00:00 2001
From: Bryan Helmkamp <bryan@brynary.com>
Date: Mon, 18 Nov 2024 15:40:22 -0500
Subject: [PATCH] readme

---
 README.md | 31 ++++++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 0fb4a7c0a..8271fbd96 100644
--- a/README.md
+++ b/README.md
@@ -20,31 +20,48 @@ Qlty CLI is implemented in Rust, supported by [Qlty Software](https://qlty.sh),
 
 Qlty CLI is available for MacOS, Linux, and Windows.
 
+### Install on MacOS or Linux
+
 ```bash
-# Install on MacOS or Linux:
 curl https://qlty.sh | bash
+```
+
+### Install on Windows
 
-# Install on Windows:
+```bash
 powershell -c "iwr https://qlty.sh | iex"
 ```
 
 ## Usage
 
+Setup Qlty within a Git repository:
+
 ```bash
-# Setup Qlty within a Git repository:
 cd my_repo/
 qlty init
+```
+
+View a sample of lint issues:
 
-# View a sample of lint issues:
+```bash
 qlty check --sample=5
+```
 
-# Auto-format the codebase
+Auto-format the codebase:
+
+```bash
 qlty fmt --all
+```
+
+Scan for code smells like duplication:
 
-# Scan for code smells like duplication:
+```bash
 qlty smells --all
+```
 
-# Review a summary of code quality metrics
+Review a summary of code quality metrics:
+
+```bash
 qlty metrics --all --max-depth=2 --sort complexity --limit 10
 ```