README

README.md

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