From c9ced0e9d79b3c0ebc8b9fec65d4a542d9636182 Mon Sep 17 00:00:00 2001
From: Zamentur aka ljf <zamentur@users.noreply.github.com>
Date: Sat, 30 Jan 2016 22:38:29 +0100
Subject: [PATCH] [enh] Add doc

---
 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 57 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6927be5..0bfdbf9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,57 @@
-# yunohost-development
-An environement to develop on YunoHost
+# ynh-dev, a yunohost dev env
+This script is a cli to manage a yunohost development environement. With this you can develop on the unstable version of yunohost quickly.
+
+## Setup
+Install dependencies
+```shell
+# Debian, Ubuntu, Mint
+sudo apt-get install docker vagrant
+# Fedora
+sudo dnf install docker vagrant vagrant-libvirt
+```
+
+Next upload ynh-dev script
+
+```shell
+wget https://raw.githubusercontent.com/zamentur/yunohost-development/master/ynh-dev
+chmod u+x ynh-dev
+```
+## Usage
+### Create the environment
+
+```shell
+ynh-dev create-env PATH
+```
+
+### Run a container
+```
+ynh-dev run ynh.local virtualbox testing8
+```
+
+###  Upgrade the container
+```
+ynh-dev upgrade
+```
+
+###  Deploy your change
+```
+ynh-dev deploy
+```
+
+### Deploy your change in realtime (each time you saved source code)
+```
+ynh-dev watch
+```
+## Useful command
+### Get ip address of your vm
+```
+ynh-dev ip
+```
+
+### Get ip address of your vm
+```
+ynh-dev ip
+```
+## More info 
+
+https://yunohost.org/#/dev_fr