Bläddra i källkod

Updated to help text as in a34b2db commit

pezcurrel 8 månader sedan
förälder
incheckning
56b87e99f5
1 ändrade filer med 12 tillägg och 9 borttagningar
  1. 12 9
      README.md

+ 12 - 9
README.md

@@ -5,7 +5,7 @@ decrypt -d <dictionary file> <phrase>
 
 DESCRIPTION
 
-This is decrypt v0.1, a CLI PHP script that can help decrypting
+This is decrypt v0.2, a CLI PHP script that can help decrypting
 phrases encrypted with any algorithm producing an encrypted phrase where each
 symbol always replaces the same, different symbol from the clear text one.
 
@@ -36,8 +36,10 @@ COMMAND LINE OPTIONS
 -m, --method <0|1>
  Choose a method for encryption when «-e» or «--encrypt» is specified (see
  previous option description). It defaults to “0”.
--p, --progress
- Show progress during script execution.
+-p, --progress <0|1|2>
+ With «0», show no progress during script execution. With «1», show bare
+ minimum progress. With «2», show detailed progress (this consumes more CPU
+ and RAM). Defaults to «0».
 -w, --write
  Write any substition table decrypt may find into a «substable.txt»
  file and any solution decrypt may find into a «solutions.txt» file.
@@ -46,14 +48,15 @@ COMMAND LINE OPTIONS
 -h, --help
  Show this help text and exit.
 
-EXAMPLE
+EXAMPLES
 
-decrypt "rûéï eïw6ï w 6fwh6ï" -d english.txt -p -w
+decrypt "ipx nvdi xppe xpvme b xppedivdl divdl?" -d english.txt -p 1 -w
 
-Will produce 983 solutions, with «give peace a chance» being one of them,
-showing progress during the execution, writing substitution tables into
-«substable.txt» and solutions into «solutions.txt» within current working
-directory.
+With the bundled «english.txt» dictionary, this will produce 68 possible
+solutions, with «how much wood would a woodchuck chuck?» being one of them,
+showing bare minimum progress during the execution, writing substitution
+tables into «substable.txt» and solutions into «solutions.txt» within
+current working directory.
 
 DISCLAIMER AND LICENSE