Moved communicatorInstance to 'core'.

[hub.git] / docs / README

diff --git a/docs/README b/docs/README
index 2a3b921a93ef481e6b9a944d8a2355cca7c0bd0d..33a874b5ecdb85cd2526efc63c767c7035260442 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -64,7 +64,7 @@ webmaster accounts... ;-)
 4.) How to start the cruncher
 --------------------------------------------------------------------------------
 
-The cruncher is a test application (or mayber later used in a serious
+The cruncher is a test application (or maybe later used in a serious
 environment?) to find the right key for an encrypted message to decrypt it. It
 can be launched with this command:
 
@@ -75,7 +75,25 @@ cruncher to work on. In the meanwhile the cruncher shall run test units which
 I will mainly use for development.
 
 --------------------------------------------------------------------------------
-5.) How to start the chat console and use it
+5.) How to start the miner
+--------------------------------------------------------------------------------
+
+The miner is a test application (or maybe later used in a serious
+environment?) to find hash blocks:
+
+php index.php app=hub command=miner
+
+--------------------------------------------------------------------------------
+6.) How to start the crawler
+--------------------------------------------------------------------------------
+
+The distributed crawler is a test application (or maybe later used in a serious
+environment?) to crawl websites and build a searchable and distributed index:
+
+php index.php app=hub command=crawler
+
+--------------------------------------------------------------------------------
+7.) How to start the chat console and use it
 --------------------------------------------------------------------------------
 
 The chat console is yet another test application for the node. You can launch
@@ -90,3 +108,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.
+
+--------------------------------------------------------------------------------
+8.) 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