From 31c2119839ed6fd6c235bf303ee3768e548d3d8c Mon Sep 17 00:00:00 2001
From: Manfred Touron <m@42.am>
Date: Thu, 12 Mar 2015 17:12:04 +0100
Subject: [PATCH] Updated README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 247b589..c3d231f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,47 @@
 Initrd on Online Labs [![Build Status](https://travis-ci.org/online-labs/initrd.svg?branch=master)](https://travis-ci.org/online-labs/initrd)
 =====================
 
-This is a work in progress.
+Initrd used to boot C1 servers.
 
-For now, you can already use the [issues](https://github.com/online-labs/initrd/issues) section.
+Based on Busybox.
+
+
+Features
+--------
+
+- configure network
+- configure time (NTP)
+- set verbosity from server tags
+- drop a debug shell from server tags
+- configure /etc/hosts and /etc/resolv.conf
+- prepare /dev, /proc, /sys, /run
+- gives information about the current boot step and status (available from the web console)
+- configure GPIOs to enable serial port
+
+
+
+Boot types
+----------
+
+- NBD: fetch `NBD_0` server address and port, and attach it as a volume on /dev/nbd0
+- RESCUE: unarchive a downloaded filesystem archive in memory (non-persistent)
+
+
+Developement dependencies
+-------------------------
+
+- Docker
+- Fig
+
+
+Commands
+--------
+
+    # build the initrd
+    make build
+
+    # push the initrd on S3
+    make publish_on_s3
+
+    # test with QEMU (beta)
+    make qemu