From 248fa8ab2d8ca2ac7c8ee403a5ff9b5a0f1cd065 Mon Sep 17 00:00:00 2001
From: n0tori <188390306+n0tori@users.noreply.github.com>
Date: Thu, 8 Jan 2026 21:36:30 +0000
Subject: update readme

---
 README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 58 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c301890..e37580b 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,68 @@
 
 ![Example file](/example.png)
 
-A simple script that displays a coloured language breakdown bar for your codebase, similar to GitHub's linguist feature.
+A lightweight bash script that displays a coloured language breakdown bar for your codebase, similar to GitHub's linguist feature.
 
-## Usage
+# Installation
 
+```bash
+# download the script
+chmod +x langbreak
+```
+
+# Usage
+
+## Basic Usage
+Display a visual breakdown of the current directory:
 ```bash
 ./langbreak
 ```
 
-Analyzes the current directory and shows a visual breakdown of programming languages by file size.
+## Help
+```bash
+./langbreak --help
+```
+
+## Options
+Export language data to JSON or YAML:
+```bash
+./langbreak --json
+./langbreak --yaml
+```
+
+Redirect to a file:
+```bash
+./langbreak --json > stats.json
+./langbreak --yaml > stats.yaml
+```
+
+### JSON Export
+```json
+{
+  "timestamp": "2026-01-08T18:34:27+00:00",
+  "total_bytes": 15234,
+  "languages": [
+    {
+      "name": "Python",
+      "bytes": 8500,
+      "files": 12,
+      "percentage": 55.8
+    }
+  ]
+}
+```
+
+### YAML Export
+```yaml
+timestamp: "2026-01-08T18:34:27+00:00"
+total_bytes: 15234
+languages:
+  - name: "Python"
+    bytes: 8500
+    files: 12
+    percentage: 55.8
+```
+
+# License
 
-## License 
-GPLv3 
+GPLv3
-- 
cgit v1.2.3