find all Parameters supported by CPE
[perl-cwmp.git] / README
diff --git a/README b/README
index 8d331ea..7b1bbda 100644 (file)
--- a/README
+++ b/README
@@ -21,3 +21,32 @@ Currently implemented:
 - 3.4.5 Digest Authentication
 + 3.4.6 Additional HTTP Requirements
 
+
+INSTALLATION
+
+Idea is to be as lightweight as possible, but some perl modules might be installed
+directly from CPAN
+
+  $ perl Makefile.PL
+  $ make
+
+will check for dependencies and install them if necesarry
+
+
+USING ACS SERVER
+
+  $ ./bin/acs.pl -d
+
+This will start server with debug output. You may repeat -d to increase debug level.
+
+Sever will listen on *:3333, so now you can configure your CPE to connect to it.
+
+When CPE first connects, ACS server will issue GetParameterNames untill it discovers
+whole hierarchy and which parameters are writable.
+
+After that, it will issue GetparameterValues requests, 16 in one batch to preserve
+resources on CPE, until it reads all values present on CPE.
+
+This will create file yaml/CPE_ID.yml with all parameters information from given CPE.
+
+