Added very basic documentation for apt-proxy, other minor fixes

[hub.git] / docs / README

diff --git a/docs/README b/docs/README
index 2a3b921a93ef481e6b9a944d8a2355cca7c0bd0d..b54b6ea59e7682f8100aae056ed6ac8938f306f7 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -90,3 +90,19 @@ telnet localhost xxxxx
 After that you will be greeted and you are able to enter simple commands. Please
 do not try any 'interactive console' things like cursor key or so. This is
 (or will be) a very simple and basic telnet console.
+
+--------------------------------------------------------------------------------
+6.) How to start the apt-proxy and use it
+--------------------------------------------------------------------------------
+
+The apt-proxy is yet another test application for the node and shall provide a
+proxy for sharing Debian packages over the node network. You can launch its
+connector by invoking this command:
+
+php index.php app=hub command=apt-proxy
+
+If you do so, another port xxxxx will be opened which you can use in your deb
+and deb-src lines:
+
+deb [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib
+deb-src [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib