@ondoher/enigma 0.1.5 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -25,6 +25,13 @@ import {Enigma} from '@ondoher/enigma';
|
|
|
25
25
|
var enigma = new Enigma({reflector: 'B'});
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
+
1In addition to this api, there is also [documentation](https://github.com/Ondoher/enigma/blob/main/docs/enigma.md)
|
|
29
|
+
that gives a brief overview of what the Enigma is, and some technical details
|
|
30
|
+
about its operation. Following that is a detailed breakdown of how to go about
|
|
31
|
+
writing a simulation and all of the small details and quirks that will need to
|
|
32
|
+
be accounted for. And there are many.
|
|
33
|
+
|
|
34
|
+
|
|
28
35
|
The API is broken into two main parts, the simulator and the message generator.
|
|
29
36
|
With the simulator you can construct an entire Enigma, or just create instances
|
|
30
37
|
of the individual components. This API is provided as a working reference that
|