Create README.md

README.md

@@ -0,0 +1,34 @@
+# Kubestr
+
+## What is it?
+
+Kubestr is a collection of tools to discover, validate and evaluate your kubernetes storage options.
+
+As adoption of kubernetes grows so have the persistent storage offerings that are available to users. The introduction of [CSI](https://kubernetes.io/blog/2019/01/15/container-storage-interface-ga/)(Container Storage Interface) has enabled storage providers to develop drivers with ease. In fact there are around a 100 different CSI drivers available today. Along with the existing in-tree providers, these options can make choosing the right storage difficult.
+
+Kubestr can assist in the following ways-
+- Identify the various storage options present in a cluster.
+- Validate if the storage options are configured correctly.
+- Evaluate the storage using common benchmarking tools like FIO.
+
+[![asciicast](https://asciinema.org/a/7iJTbWKwdhPHNWYV00LIgx7gn.svg)](https://asciinema.org/a/7iJTbWKwdhPHNWYV00LIgx7gn)
+
+## Using Kubestr
+### To install the tool -  
+- Ensure that the kubernetes context is set and the cluster is accessible through your terminal. (Does [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) work?)
+- Download the latest release [here](https://github.com/kastenhq/kubestr/releases/latest). 
+- Unpack the tool and make it an executable `chmod +x kubestr`.
+
+### To discover available storage options -
+- Run `./kubestr`
+
+### To run an FIO test - 
+- Run `./kubestr fio -s <storage class>`
+- Additional options like `--size` and `--fiofile` can be specified.
+- For more information visit our [fio](https://github.com/kastenhq/kubestr/blob/master/FIO.md) page.
+
+### To check a CSI drivers snapshot and restore capabilities - 
+- Run `./kubestr csicheck -s <storage class> -v <volume snapshot class>`
+
+## Roadmap
+- In the future we plan to allow users to post their FIO results and compare to others.