Skip to content

Commit 676e4d5

Browse files
committed
Added gif
1 parent 203ba82 commit 676e4d5

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Version](https://img.shields.io/cocoapods/v/EnigmaKit.svg?style=flat)](http://cocoapods.org/pods/EnigmaKit)
55
[![License](https://img.shields.io/cocoapods/l/EnigmaKit.svg?style=flat)](http://cocoapods.org/pods/EnigmaKit)
66
[![Platform](https://img.shields.io/cocoapods/p/EnigmaKit.svg?style=flat)](http://cocoapods.org/pods/EnigmaKit)
7+
![Alt text](enigma.gif "Enigma")
78

89
## Usage
910
```swift
@@ -13,24 +14,24 @@ let result = enigma.encode("Hello world")
1314

1415
To run the example project, clone the repo, and run `pod install` from the Example directory first.
1516

16-
### Plugboard
17+
#### Plugboard
1718
```swift
1819
// Create a plugboard and add a patch between A and D
1920
let plugboard = Plugboard()
2021
plugboard.addPatch(("A", "D"))
2122
```
22-
### Rotor
23+
#### Rotor
2324
```swift
2425
// III rotor
2526
let rotor = Rotor.III
2627
rotor.setting = 5 // Internal ring position
2728
rotor.position = 6 // Outer ring position
2829
```
29-
### Reflector
30+
#### Reflector
3031
```swift
3132
let rotor = Reflector.B
3233
```
33-
### Enigma
34+
#### Enigma
3435
```swift
3536
// Create an enigma with your own plugboard, rotors and reflector of choice
3637
let enigma = Enigma(plugboard: Plugboard(), rotors: [Rotor.III, Rotor.IV, Rotor.II], reflector: Reflector.C)

enigma.gif

191 KB
Loading

0 commit comments

Comments
 (0)