Repository initialization

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f635d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+Hydra Suite - Cloud Command and Control
+=======================================
+
+The Hydra Suite is a complete set of tools for orchestration and management
+of computers.
+
+This suite is made of three commands:
+
+  - hydractl: issues commands in the current host.
+  - hydra:    issues commands on multiple hosts.
+  - hydras:   issues commands to multiple sets of hosts.
+
+Installation
+------------
+
+First, clone the code:
+
+    git clone git://git.sarava.org/hydra.git
+    cd hydra && git tag -v
+
+Then add hydra folder to your `$PATH` or run the following command to install
+if under `/usr/local`:
+
+    ./hydractl provision
+
+Managing an existing network
+----------------------------
+
+If you have enough credentials, you can fetch all the needed repositories and configurations
+using simply the following command:
+
+    hydra example init ~/file/example ssh://gitolite@admin.example.org/config.git
+
+Creating a new network
+----------------------
+
+To create the needed repositories to start a new network, use a similar command:
+
+    hydra example init ~/file/example