updated README to include full usage example
[HTTP-Proxy-Archive.git] / README
diff --git a/README b/README
index c7dc077..7370641 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,22 @@
 HTTP Proxy Arhive
 
-$ google-chrome --user-data-dir=/tmp/chrome/ --proxy-pac-url=http://193.198.212.253:1234/proxy.pac
+Extended HTTP::Proxy perl module to support proxy.pac generation, digest http auth and
+(planned) selectable arhiving of content per user.
+
+Source: http://github.com/dpavlin/HTTP-Proxy-Archive
+
+
+Checkout source:
+
+$ git clone git@github.com:dpavlin/HTTP-Proxy-Archive.git
+$ cd HTTP-Proxy-Archive
+
+
+Start proxy:
+
+$ ./proxy.pl
+
+
+Configure Google Chrome to use it:
+
+$ google-chrome --user-data-dir=/tmp/chrome/ --proxy-pac-url=http://localhost:8080/proxy.pac