prepare 1.1.0

[linksys-wrt3g-tools.git] / README

diff --git a/README b/README
index 8fdd2d3095613052c87fd764f0ec553f5c7e7548..533f1b42503d61cf06bcea69d5c3a03fb0242dc0 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,43 @@
 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 packages:
+- Config
+- Console_CommandLine
+- HTTP_Request2
+- System_Folders