Also always update this, is there an auto-executing hook available on client-side?

[hub.git] / docs / README

diff --git a/docs/README b/docs/README
index a2313e88310ceba2ef8e737039c0287ddba9e48f..2a3b921a93ef481e6b9a944d8a2355cca7c0bd0d 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -6,8 +6,8 @@ README
 --------------------------------------------------------------------------------
 
 At the current stage of code base you need to launch the hub by entering the
-following command at at command prompt (Win32) or console (Linux etc.) in the
-root directory of this script:
+following command at a command prompt (Win32) or console (Linux, etc.) in the
+root directory:
 
 php index.php app=hub
 
@@ -53,9 +53,40 @@ just 'hey, my code runs' code.
 This software is simply called "hub". This has a simple reason that this is,
 first, the "working title" for it. And second, I have found no better name than
 "Generic Object Sharing Hub" for this. I would not shortcut it to "Gosh" or
-"GNU Gosh" or such other title, because the word "gosh" is english and
+"GNU Gosh" or such other title, because the word "gosh" is English and
 completely misleading.
 
 So if you have a really good ("selling") name, please send it to me:
 roland[at]mxchange[dot]org or webmaster[at]ship-simu[dot]org if you prefer
 webmaster accounts... ;-)
+
+--------------------------------------------------------------------------------
+4.) How to start the cruncher
+--------------------------------------------------------------------------------
+
+The cruncher is a test application (or mayber 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:
+
+php index.php app=hub command=cruncher
+
+A producer application will follow which shall produce work units for the
+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
+--------------------------------------------------------------------------------
+
+The chat console is yet another test application for the node. You can launch
+its "server-side" part by invoking this command:
+
+php index.php app=hub command=chat
+
+If you do so, another port xxxxx will be opened where you can telnet to:
+
+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.