feat: add README information

Author: dareste

README.md

@@ -1 +1,51 @@
-# kubectl-kic-supportpkg
+# kubectl-kic-supportpkg
+
+A kubectl plugin designed to collect diagnostics information on the designated namespaces.
+
+## Features
+
+The plugin collects the following global and namespace-specific information:
+
+- k8s version, nodes information and CRDs
+- pods logs
+- list of pods, events, configmaps, services, deployments, statefulsets, replicasets and leases
+- k8s metrics
+- helm deployments
+
+## Installation
+
+Clone the repo and run `make install`. This will build the binary and copy it on `/usr/local/bin/`.
+
+Verify that the plugin is properly found by `kubectl`:
+
+```
+$ kubectl plugin list
+The following compatible plugins are available:
+
+/usr/local/bin/kubectl-kic-supportpkg
+```
+
+## Usage
+
+The plugin is invoked via `kubectl kic supportpkg` and has only one required flag, `-n` or `--namespace`:
+
+```
+$ kubectl kic supportpkg -n default -n nginx-ingress-0
+Running job pod-list... OK
+Running job collect-pods-logs... OK
+Running job events-list... OK
+Running job configmap-list... OK
+Running job service-list... OK
+Running job deployment-list... OK
+Running job statefulset-list... OK
+Running job replicaset-list... OK
+Running job lease-list... OK
+Running job k8s-version... OK
+Running job crd-info... OK
+Running job nodes-info... OK
+Running job metrics-information... OK
+Running job helm-info... OK
+Running job helm-deployments... OK
+Supportpkg successfully generated: kic-supportpkg-1711384966.tar.gz
+
+```