changeset 29:f8734f73baa8

Update the README with an example command-line invocation.
author Brian Neal <bgneal@gmail.com>
date Tue, 29 May 2012 17:30:49 -0500
parents 067205259796
children 62e0d0e2628b
files README.txt
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Tue May 29 17:21:16 2012 -0500
+++ b/README.txt	Tue May 29 17:30:49 2012 -0500
@@ -74,6 +74,17 @@
 
    THEXRUSSIANSXAREXCOMINGX
 
+Py-Enigma also includes a command-line application for processing messages.
+Assuming you have a proper key file that contains the same initial settings as
+the code above, the above example can be performed on the command-line::
+
+   $ pyenigma --key-file=keys.txt --start=WXC --text='KCH'
+   BLA
+   $ pyenigma --key-file=keys.txt --start=BLA --text='NIBLFMYMLLUFWCASCSSNVHAZ'
+   THEXRUSSIANSXAREXCOMINGX
+
+The format of the key file can be found in the documentation.
+
 
 Requirements
 ------------