From 501dcf92e39f3383e0583a6a14787f6c8f2b552c Mon Sep 17 00:00:00 2001
From: Valery Barsukov <barval@mail.ru>
Date: Tue, 3 Aug 2021 14:57:57 +0300
Subject: [PATCH] README

---
 README.md     | 21 +++++++++++++++++++--
 ns-remover.sh |  2 +-
 2 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index e1b7e92..7e4b39e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
-# ns-remover
+# NAMESPACE Remover
+Средство удаления "застрявших" NAMESPACE (находящихся в стадии Terminating).
+Удаление такого окружения выполняется если в нём нет подов.
 
-Средство удаления "застрявших" Namespaces (находящихся в стадии Terminating)
\ No newline at end of file
+## Требования
+- установленные kubectl, curl
+- настроенный доступ kubectl в необходимый Kubernetes-кластер
+
+## Использование
+Запустить ns-remover с указанием "застрявшего" NAMESPACE, который необходимо удалить:
+```sh
+./ns-remover.sh NAMESPACE
+```
+
+## Коды завершения
+0 - успешное завершение
+1 - нет обязательного аргумента (не указан NAMESPACE)
+2 - окружение NAMESPACE не найдено
+3 - окружение NAMESPACE не подходит для удаления (не находится в стадии Terminating)
+4 - еще остались запущенные поды в окружении NAMESPACE
diff --git a/ns-remover.sh b/ns-remover.sh
index 716ac0c..a72a7b3 100755
--- a/ns-remover.sh
+++ b/ns-remover.sh
@@ -82,7 +82,7 @@ kubectl proxy &
 sleep 3
 
 # Удаляем окружение (вариант 2)
-echo "GNR: Удаляем окружение $NAMESPACE:"
+echo "NR: Удаляем окружение $NAMESPACE:"
 curl -k -H "Content-Type: application/json" -X PUT --data-binary @tmp2.json http://127.0.0.1:8001/api/v1/namespaces/$NAMESPACE/finalize
 
 # Удаляем окружение (вариант 1)