Create BASEDIR / doc update

1 files changed, 25 insertions, 8 deletions

diff --git a/README b/README
index b61abc4..5f635d8 100644
--- a/README
+++ b/README
@@ -10,13 +10,30 @@ This suite is made of three commands:
   - hydra:    issues commands on multiple hosts.
   - hydras:   issues commands to multiple sets of hosts.
 
-TODO
-----
+Installation
+------------
 
-Hydra:
+First, clone the code:
 
-  - Init: create config and doc repositories.
-  - Init: generate puppet repository using "hydractl bootstrap repository"
-  - Sync: split between public and private repositories.
-  - Sync: Git clone URL recommendation which support for both git-annex and non-standard port.
-  - Uniform syntax for specifying nodes (either by hostname or fqdn) on deploy and import-key.
+    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