README

README.md

@@ -1,3 +1,19 @@
-# pv-remover
+# PV Remover
+Средство удаления "застрявших" PV (находящихся в стадии Terminating) в кластере Kubernetes.  
 
-Средство удаления "застрявших" PV (находящихся в стадии Terminating)
+## Требования
+- установленный пакет kubectl
+- настроенный доступ kubectl в необходимый Kubernetes-кластер
+
+## Использование
+Запустить pv-remover.sh с указанием "застрявшего" PV, который необходимо удалить:
+```sh
+./pv-remover.sh PV
+```
+
+## Коды завершения
+0 - успешное завершение  
+1 - нет обязательного аргумента (не указан PV)  
+2 - PV не найден  
+3 - PV не подходит для удаления (не находится в стадии Terminating)  
+4 - еще остались запущенные поды в окружении NAMESPACE