Skip to content

Commit d026e48

Browse files
authored
Merge pull request #14 from Dunkelhaiser/dev
Reordered alphabets in documentation
2 parents 0e8ec2c + fb73e8c commit d026e48

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# @dunkelhaiser/caesar-cipher
22

3+
## 2.0.5
4+
5+
### Patch Changes
6+
7+
- Reordered alphabet support in documentation
8+
39
## 2.0.4
410

511
### Patch Changes

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,21 @@ CaesarCipher.decrypt("Olssv Tf Ilhbapmbs Dvysk!", 7); // => "Hello My Beautiful
8383
CaesarCipher.encrypt(["Hello", "My", "Beautiful", "World!"], 7); // => ["Olssv", "Tf", "Ilhbapmbs", "Dvysk!"]
8484
```
8585

86-
### Numeric Support
86+
### Use own alphabet
8787

88-
If numbers are provided in the alphabet they also will be shifted, otherwise they stay untouched.
88+
If you wish to use a custom alphabet for encryption and decryption, you can provide it as the third parameter:
8989

9090
```ts
91-
CaesarCipher.encrypt("12345", 5); // => "12345"
92-
CaesarCipher.encrypt("12345", 5, "0123456789"); // => "67890"
91+
CaesarCipher.encrypt("Привіт мій прекрасний диво-світ!", 7, "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя"); // => "Цчнзощ уор цчйсчєшфнр їнзх-шзощ!"
9392
```
9493

95-
### Use own alphabet
94+
### Numeric Support
9695

97-
If you wish to use a custom alphabet for encryption and decryption, you can provide it as the third parameter:
96+
If numbers are provided in the alphabet they also will be shifted, otherwise they stay untouched.
9897

9998
```ts
100-
CaesarCipher.encrypt("Привіт мій прекрасний диво-світ!", 7, "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя"); // => "Цчнзощ уор цчйсчєшфнр їнзх-шзощ!"
99+
CaesarCipher.encrypt("12345", 5); // => "12345"
100+
CaesarCipher.encrypt("12345", 5, "0123456789"); // => "67890"
101101
```
102102

103103
## API

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@dunkelhaiser/caesar-cipher",
3-
"version": "2.0.4",
3+
"version": "2.0.5",
44
"description": "Implementation of the Caesar Cipher encryption algorithm in JavaScript. The Caesar Cipher is a classic substitution cipher technique where each letter in the plaintext is shifted a certain number of places down or up the alphabet.",
55
"private": false,
66
"keywords": [

0 commit comments

Comments
 (0)