From bada6fc8a7837b66f77afc88d887ddd9ef8dbeb9 Mon Sep 17 00:00:00 2001
From: Guillaume Mazoyer <respawneral@gmail.com>
Date: Wed, 28 May 2014 00:27:45 +0200
Subject: Some info in the README file before opening the hostilities.

---
 README.md | 36 ++++++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 44172de..71f9c14 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,36 @@
-looking-glass
+Looking Glass
 =============
 
-Easy to deploy Looking Glass
+Easy to deploy Looking Glass made in PHP.
+
+Requirements
+------------
+
+  * Webserver such as Apache 2, or Lighttpd, etc…
+  * PHP module for the webserver (mod-php5 for Apache 2 for example)
+  * SSH2 library for PHP libssh2-php
+
+Description
+-----------
+
+This web application made in PHP is what we call a **Looking Glass**. This is a
+tool used to get some information about networks by giving the opportunity to
+execute some commands on routers. The output is sent back to the user.
+
+For now this looking glass is quite simple. Here you have some features:
+
+  * Interface using Javascript and AJAX calls (needs a decent browser)
+  * Support of Juniper routers
+  * Support of SSH connection to routers using password authentication
+  * Configurable list of routers
+  * Tweakable interface (title, logo, footer)
+  * Log all commands in a file
+
+Configuration
+-------------
+
+License
+-------
+
+Looking Glass is released under the terms of the GNU GPLv3. Please read the
+LICENSE file for more informations.
-- 
cgit v1.2.3