implement non-authenticated default status

[linksys-wrt3g-tools.git] / README

diff --git a/README b/README
index 1c9f2607a239733856d17acbfd74f2d82bf5a32f..533f1b42503d61cf06bcea69d5c3a03fb0242dc0 100644 (file)
--- a/README
+++ b/README
@@ -9,3 +9,35 @@ 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