From f8b05a1fed71b89b1cd7524e4f64b317af1ab7a4 Mon Sep 17 00:00:00 2001
From: Guillaume Mazoyer <respawneral@gmail.com>
Date: Thu, 29 May 2014 13:52:23 +0200
Subject: Add a contact part to the README file. Add comments to the example
 configuration file.

---
 README.md          | 10 ++++++++++
 config.php.example | 18 +++++++++++++++++-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3b6a166..d49f552 100644
--- a/README.md
+++ b/README.md
@@ -47,3 +47,13 @@ License
 
 Looking Glass is released under the terms of the GNU GPLv3. Please read the
 LICENSE file for more informations.
+
+Contact
+-------
+
+If you have any bugs, errors, improvements, patches, ideas, you can contact me
+on my email address <gmazoyer@gravitons.in>. You are also welcome to fork and
+make some pull requests.
+
+If you use this looking glass in your company, please drop me a mail. I would
+be glad to know that this project was helpful for you.
diff --git a/config.php.example b/config.php.example
index aa0e003..7666cb3 100644
--- a/config.php.example
+++ b/config.php.example
@@ -1,22 +1,38 @@
 <?php
 
+// People to contact
 $config['contact']['name'] = 'Example Support';
 $config['contact']['mail'] = 'support@example.com';
 
+// Frontpage configuration
+
+// Title of the page
 $config['frontpage']['title'] = 'Looking Glass';
+// Logo to display
 $config['frontpage']['image'] = 'logo.png';
+// Disclaimer to inform people using the looking glass
 $config['frontpage']['disclaimer'] = 'This is a disclaimer!';
 
+// Logs file when commands will be written
 $config['misc']['logs'] = '/var/log/looking-glass.log';
 
+// Things to remove from the output (PHP compatible regex)
 $config['filters'][0] = '/(client1|client2)/';
 $config['filters'][1] = '/^NotToShow/';
 
+// Router definition
+
+// The hostname or the IP address
 $config['routers']['router1']['host'] = 'r1.example.net';
+// The user to use to connect to the router
 $config['routers']['router1']['user'] = 'readonlyuser';
+// The password of the given user
 $config['routers']['router1']['pass'] = 'readonlypassword';
-$config['routers']['router1']['auth'] = 'ssh2-password';
+// The authentication mecanism to use (ssh-password only for now)
+$config['routers']['router1']['auth'] = 'ssh-password';
+// The router type (juniper/junos only supported for now)
 $config['routers']['router1']['type'] = 'junos';
+// The router description to be displayed in the router list
 $config['routers']['router1']['desc'] = 'Example\'s Router 1';
 
 // End of config.php
-- 
cgit v1.2.3