From 47244ebb67607b41149e05cc21321efd2bbd7b4a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A1bio=20Kaiser=20Rauber?= <fabior@interlegis.leg.br>
Date: Fri, 22 Apr 2022 17:55:18 +0000
Subject: [PATCH] Update README

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d2d1d96..e15d251 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
 # docker-pv-resizer
 
-Docker image with a script to automatically resize PersistentVolumes in Kubernetes
\ No newline at end of file
+Docker image with a script to automatically resize PersistentVolumes in Kubernetes. It leverages kubectl df-pv plugin to get kubelet metrics for each volume. 
+
+Requires kubectl with a configuration file in ~/.kube/config and df-pv krew plugin.
+
+Usage:
+  ./check_full_pvs.sh [-t threshold] [-f]"
+  
+Parameters:
+  -t (optional) : Threshold to use for near full PV evaluation (in %). Defaults to 85%.
+  -f (optional) : Fix near full PVs (resize them). Defaults to false.
+  -i (optional) : Percentage of PV increase when resizing. Defaults to 50%.
\ No newline at end of file