summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOrome <>2018-12-03 21:08:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2018-12-03 21:08:00 (GMT)
commitcc0d801f628e001749bb81be371c8eebc065663b (patch)
tree25c97f8fa64d530807056307e88ce413921615bb /README.md
parentaf9e0436e596e16c2e04516b2cb6b03bef723d45 (diff)
version 0.1.1.30.1.1.3
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index 57e6bd1..d43f4e7 100644
--- a/README.md
+++ b/README.md
@@ -30,9 +30,9 @@ Perform [message encoding]:
Show [configuration details]:
- >>> let cfg = configEnigma "b-γ-V-VIII-II" "LFAP" "UX.MO.KZ.AY.EF.PL" "03.17.04.11"
- >>> putStr $ showEnigmaConfigInternal cfg 'K'
- K > ABCDEFGHIJK̲̅LMNOPQRSTUVWXYZ
+ >>> let cfg = configEnigma "b-γ-V-VIII-II" "LFAQ" "UX.MO.KZ.AY.EF.PL" "03.17.04.11"
+ >>> putStr $ displayEnigmaConfig cfg 'K' displayOpts{format="internal"}
+ K > ABCDEFGHIJK̲̅LMNOPQRSTUVWXYZ
P YBCDFEGHIJZ̲̅PONMLQRSTXVWUAK UX.MO.KZ.AY.EF.PL
1 LORVFBQNGWKATHJSZPIYUDXEMC̲̅ Q 07 II
2 BJY̲̅INTKWOARFEMVSGCUDPHZQLX A 24 VIII
@@ -45,11 +45,10 @@ Show [configuration details]:
1 LFZVXEINSOKAYHBRG̲̅CPMUDJWTQ II
P YBCDFEG̲̅HIJZPONMLQRSTXVWUAK UX.MO.KZ.AY.EF.PL
G < CMAWFEKLNVG̲̅HBIUYTXZQOJDRPS
-
Simulate [machine operation]:
>>> let cfg = configEnigma "b-γ-V-VIII-II" "LFAP" "UX.MO.KZ.AY.EF.PL" "03.17.04.11"
- >>> putStr $ showEnigmaOperation cfg "KRIEG"
+ >>> putStr $ displayEnigmaOperation cfg "KRIEG" displayOpts
OHNKJYSBTEDMLCARWPGIXZQUFV LFAP 10 16 24 06
K > CMAWFEKLNVG̲̅HBIUYTXZQOJDRPS LFAQ 10 16 24 07
R > HXETCUMASQNZGKRYJO̲̅IDFWVBPL LFAR 10 16 24 08
@@ -142,10 +141,14 @@ will work. More detail about planned releases and activities can be found the li
list of [open issues]. Some recent activity includes:
* [changes since](https://github.com/orome/crypto-enigma-hs/compare/hackage...develop#files_bucket) the latest Hackage
- release version; and
+ release version;
* the [addition of a command line interface](https://github.com/orome/crypto-enigma-hs/issues/13)
which incorporates [extensive changes](https://github.com/orome/crypto-enigma-hs/compare/1d303d3d...eb249974)
- [including](https://github.com/orome/crypto-enigma-hs/blob/develop/CHANGELOG.md#0031) refactoring of display functions.
+ [including](https://github.com/orome/crypto-enigma-hs/blob/develop/CHANGELOG.md#0031) refactoring of display
+ functions; and
+* [breaking API changes](https://github.com/orome/crypto-enigma-hs/blob/develop/CHANGELOG.md#0111)
+ [including](https://github.com/orome/crypto-enigma-hs/compare/ef97f8ac..62d0ff59) removal of deprecated display
+ functions and change to handling of errors with `Either`.
[Python version]: https://pypi.python.org/pypi/crypto-enigma
[documentation]: https://hackage.haskell.org/package/crypto-enigma