Internal TODO closed, description of NetworkPackage class updated

[hub.git] / docs / README

diff --git a/docs/README b/docs/README
index fbc1067586de2fe2697d5179dd63f75e76380e7b..71b3873579669a0acf32979d55d925de921f4c8b 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -59,3 +59,17 @@ 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.