From 1b7ded5f8af4b669ba663b0e2e3fa3605f0069b6 Mon Sep 17 00:00:00 2001
From: Noah Swerhun <noah@noahsw.xyz>
Date: Fri, 24 May 2024 18:53:16 -0500
Subject: [PATCH] added waybar usage info

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index f07b975..14345fd 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,21 @@
 sum proportional set size of every process for accurate memory usage statistics.
 In non-pretty mode, the number is given in kibibytes.
 
+This version is for use with [waybar](https://github.com/Alexays/Waybar). It
+outputs JSON that waybar can interpret using a 
+[custom module](https://github.com/Alexays/Waybar/wiki/Module:-Custom). 
+
+Here is an example configuration:
+```json
+"custom/pss-memory": {
+  "exec": "pss-total-waybar",
+  "return-type": "json",
+  "restart-interval": 3,
+  "format": "{} {icon}",
+  "format-icons": ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"]
+}
+```
+
 Licensed under GPLv3.
 
 ### Summary