Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
taxborn committed Nov 27, 2022
1 parent 825a74e commit 2ce9690
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# playfair-rs - [Playfair Cipher](https://en.wikipedia.org/wiki/Playfair_cipher) in [Rust](https://www.rust-lang.org/).
Origionally was an assignment for my CS 303: Databases and Information Security class,
I wanted to take some more time and implement it again. This is that solution to implementing
Originally was an assignment for my CS 303: Databases and Information Security class,
I wanted to take some more time and implement it again. This is my solution to implementing
the [Playfair Cipher](https://en.wikipedia.org/wiki/Playfair_cipher) in Rust.

## Design choices
Expand All @@ -22,7 +22,7 @@ with assertions in the code, I have a pretty good idea that my code is correct.
## Examples
You can see an example in [main.rs](./src/main.rs), or here is a simple shown implementation:

**Encrypt:**
**Encryption steps:**
```rust
use playfair::{Cipher, Playfair};

Expand All @@ -35,7 +35,7 @@ fn main() {
}
```

**Decrypt:**
**Decryption steps:**
```rust
use playfair::{Cipher, Playfair};

Expand All @@ -45,5 +45,7 @@ fn main() {
let out = pf.decrypt("bmodzbxdnabekudmuixmmouvif");

// out = hidethegoldinthetrexestump
// NOTE: the extra 'x' here ^ is expected since it was inserted during the encryption process.
// Read more about the Playfair cipher to understand why.
}
```

0 comments on commit 2ce9690

Please sign in to comment.