Skip to content

Commit

Permalink
updated readme (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
sheroz committed Aug 4, 2023
1 parent 64fb45a commit ff9154f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Tests are implemented using: [crypto_vectors](https://crates.io/crates/crypto_ve

Please look at [magma_samples](https://github.com/sheroz/magma/tree/main/magma_samples/src/main.rs)

### Block encryption sample [encrypt_block.rs](encrypt_block.rs)
### Block encryption sample: [encrypt_block.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_block.rs)

```rust
use cipher_magma::Magma;
Expand All @@ -59,7 +59,7 @@ assert_eq!(decrypted, source);

```

### Text encryption sample [encrypt_text.rs](encrypt_text.rs)
### Text encryption sample: [encrypt_text.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_text.rs)

```rust
use cipher_magma::{CipherMode, CipherOperation, Magma};
Expand Down Expand Up @@ -92,7 +92,7 @@ assert_eq!(decrypted, source);
println!("Decrypted:\n{}\n", String::from_utf8(decrypted).unwrap());
```

### Message Authentication Code (MAC) sample [calculate_mac.rs](calculate_mac.rs)
### Message Authentication Code (MAC) sample: [calculate_mac.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/calculate_mac.rs)

```rust
use cipher_magma::{mac, Magma};
Expand Down Expand Up @@ -124,7 +124,7 @@ println!("Calculated MAC:\n{:x}\n", mac);
assert_eq!(mac, 0x154e7210);
```

### File encryption sample [encrypt_file.rs](encrypt_file.rs)
### File encryption sample: [encrypt_file.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_file.rs)

```rust
use cipher_magma::{CipherMode, CipherOperation, Magma};
Expand Down
8 changes: 4 additions & 4 deletions cipher_magma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Tests are implemented using: [crypto_vectors](https://crates.io/crates/crypto_ve

Please look at [magma_samples](https://github.com/sheroz/magma/tree/main/magma_samples/src/main.rs)

### Block encryption sample [encrypt_block.rs](encrypt_block.rs)
### Block encryption sample: [encrypt_block.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_block.rs)

```rust
use cipher_magma::Magma;
Expand All @@ -59,7 +59,7 @@ assert_eq!(decrypted, source);

```

### Text encryption sample [encrypt_text.rs](encrypt_text.rs)
### Text encryption sample: [encrypt_text.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_text.rs)

```rust
use cipher_magma::{CipherMode, CipherOperation, Magma};
Expand Down Expand Up @@ -92,7 +92,7 @@ assert_eq!(decrypted, source);
println!("Decrypted:\n{}\n", String::from_utf8(decrypted).unwrap());
```

### Message Authentication Code (MAC) sample [calculate_mac.rs](calculate_mac.rs)
### Message Authentication Code (MAC) sample: [calculate_mac.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/calculate_mac.rs)

```rust
use cipher_magma::{mac, Magma};
Expand Down Expand Up @@ -124,7 +124,7 @@ println!("Calculated MAC:\n{:x}\n", mac);
assert_eq!(mac, 0x154e7210);
```

### File encryption sample [encrypt_file.rs](encrypt_file.rs)
### File encryption sample: [encrypt_file.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_file.rs)

```rust
use cipher_magma::{CipherMode, CipherOperation, Magma};
Expand Down
8 changes: 4 additions & 4 deletions magma_samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Tests are implemented using: [crypto_vectors](https://crates.io/crates/crypto_ve

Please look at [magma_samples](https://github.com/sheroz/magma/tree/main/magma_samples/src/main.rs)

### Block encryption sample [encrypt_block.rs](encrypt_block.rs)
### Block encryption sample: [encrypt_block.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_block.rs)

```rust
use cipher_magma::Magma;
Expand All @@ -59,7 +59,7 @@ assert_eq!(decrypted, source);

```

### Text encryption sample [encrypt_text.rs](encrypt_text.rs)
### Text encryption sample: [encrypt_text.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_text.rs)

```rust
use cipher_magma::{CipherMode, CipherOperation, Magma};
Expand Down Expand Up @@ -92,7 +92,7 @@ assert_eq!(decrypted, source);
println!("Decrypted:\n{}\n", String::from_utf8(decrypted).unwrap());
```

### Message Authentication Code (MAC) sample [calculate_mac.rs](calculate_mac.rs)
### Message Authentication Code (MAC) sample: [calculate_mac.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/calculate_mac.rs)

```rust
use cipher_magma::{mac, Magma};
Expand Down Expand Up @@ -124,7 +124,7 @@ println!("Calculated MAC:\n{:x}\n", mac);
assert_eq!(mac, 0x154e7210);
```

### File encryption sample [encrypt_file.rs](encrypt_file.rs)
### File encryption sample: [encrypt_file.rs](https://github.com/sheroz/magma/tree/main/magma_samples/src/samples/encrypt_file.rs)

```rust
use cipher_magma::{CipherMode, CipherOperation, Magma};
Expand Down

0 comments on commit ff9154f

Please sign in to comment.