Linksys WRT3G UMTS router tools
===============================
-Tools to retrieve status information from a Wrt3G Linksys router,
- reboot it and a munin plugin.
+Tools to retrieve status information from a WRT3G Linksys router,
+ reboot it and a munin plugin to track the connection state.
+
+
+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. Environment variables
+
+3. User configuration file
+ ~/.config/linksys-wrt3g-tools
+
+4. 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, and environment variables, are
+ - host
+ - user
+ - password
+(lowercase)
+
+
+Dependencies
+------------
+- PEAR Config package
+- PEAR System_Folders package
+- PEAR Console_CommandLine