support configuration of munin plugin through environment variables

[linksys-wrt3g-tools.git] / README

diff --git a/README b/README
index 1c9f2607a239733856d17acbfd74f2d82bf5a32f..7475c5873386f46b23db1e456cfc05a5a842fd49 100644 (file)
--- a/README
+++ b/README
@@ -9,3 +9,28 @@ The routers are also known under the names:
 - Wireless-G Router for 3G/UMTS Broadband
 - Linksys WRT54G3G-EU Wireless-G UMTS Router
 - WRT54G3G
+
+
+Configuration
+-------------
+The tools can be configured in three ways:
+1. Commandline options
+   Use --help to get an overview
+
+2. User configuration file
+   ~/.config/linksys-wrt3g-tools
+
+3. System configuration file
+   /etc/linksys-wrt3g-tools
+
+The configuration files are normal ini-style files with key=value
+lines. Supported configuration options in the files are
+ - host
+ - user
+ - password
+
+
+Dependencies
+------------
+- PEAR Config package
+- PEAR System_Folders package