diff --git a/.github/workflows/check_deprecated.yaml b/.github/workflows/check_deprecated.yaml
index 002115b..29110e8 100644
--- a/.github/workflows/check_deprecated.yaml
+++ b/.github/workflows/check_deprecated.yaml
@@ -10,7 +10,7 @@ jobs:
name: Test
runs-on: ubuntu-latest
steps:
- # Delete the previous comments
+ # Delete the previous comments created by github-action[bot]
- name: pr-deleter
uses: maheshrayas/action-pr-comment-delete@v1
with:
@@ -20,6 +20,7 @@ jobs:
user: 'github-actions[bot]'
issue: '${{github.event.number}}'
- uses: actions/checkout@v2
+ # Install kube-depre and run it against the manifest file dir
- name: Check kubedepre
id: kubedepre
run: |
diff --git a/Cargo.lock b/Cargo.lock
index 5e8d02a..913c1ae 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -910,7 +910,7 @@ dependencies = [
[[package]]
name = "kube-depre"
-version = "0.1.0"
+version = "0.1.8"
dependencies = [
"anyhow",
"async-trait",
diff --git a/Cargo.toml b/Cargo.toml
index 7a289d5..3ab431b 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "kube-depre"
-version = "0.1.0"
+version = "0.1.9"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/README.md b/README.md
index fe5baf9..6537d0e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,102 @@
-# Kube-depre
-[![GitHub Actions Workflow](https://github.com/maheshrayas/kube-depre/actions/workflows/ci.yaml/badge.svg)](https://github.com/anzx/platform-secret-management/actions/workflows/ci.yaml)
-[![codecov](https://codecov.io/gh/maheshrayas/kube-depre/branch/main/graph/badge.svg?token=VF6UCCDNXI)](https://codecov.io/gh/maheshrayas/kube-depre)
\ No newline at end of file
+
+
+
Kube-depre
+
+
+
+
+
+
+
+
+## Motivation
+
+Given that kubernetes frequently deprecates apiVersions, we want to check for the resources with deprecated apiVersions in cluster or files or as a part of Continous Integration pipeline (Github Actions) so that we can update the apiVersion in manifest before the cluster is upgraded.
+
+`kube-depre` is a simple CLI tool that allows us to find such deprecated apiVersion in Kubernetes cluster, or in files and as well integrated with github actions to report the Deprecated Apis as a comment on Pull Request.
+
+## Installation
+
+Supports only Linux and Mac
+
+1. Download from the [Release](https://github.com/maheshrayas/kube-depre/releases)
+
+OR
+
+2. curl -L https://raw.githubusercontent.com/maheshrayas/kube-depre/main/release/install.sh | sh -
+
+
+## How to use
+
+### CLI Supported Args
+
+```bash
+kube-depre 0.1.8
+
+USAGE:
+ kube-depre [OPTIONS]
+
+OPTIONS:
+ -d, --debug
+ supply --debug to print the debug information
+
+ -f, --file
+ supply -f or --file "Manifest file directory". if -f not supplied, it will by default
+ query the cluster
+
+ -h, --help
+ Print help information
+
+ -k, --kubeconfig
+
+
+ -o, --output