First commit

1 files changed, 37 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c03bc86
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+krash
+=====
+
+Crash nodes on demand.
+Because sometimes, you have to break stuff to debug.
+
+Dependencies
+------------
+
+* kubectl
+
+Installation
+------------
+
+Installing krash requires a working Autotools setup.
+
+a) To install it from a cloned repository:
+
+    $ aclocal
+    $ autoconf
+    $ automake --add-missing
+    $ ./configure
+    $ make install
+
+Usage
+-----
+
+Just use the krash command followed by a node:
+
+    $ krash <node-name> [-r|--reboot]
+
+Or use it as a kubectl plugin:
+
+    $ kubectl node-crash ...
+
+
+