Skip to content

Commit ceaf889

Browse files
authored
Merge pull request #9 from Dunkelhaiser/dev
Updated documentation
2 parents 82500f5 + 807647d commit ceaf889

File tree

3 files changed

+31
-3
lines changed

3 files changed

+31
-3
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.1
4+
5+
### Patch Changes
6+
7+
- Updated documentation
8+
39
## 2.0.0
410

511
### Major Changes

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,38 @@ bun add @dunkelhaiser/caesar-cipher
3131

3232
### Importing the Library
3333

34-
Using ESM
34+
#### Using ESM
35+
36+
With named import
3537

3638
```ts
3739
import { CaesarCipher } from "@dunkelhaiser/caesar-cipher";
3840
```
3941

42+
With named imports
43+
44+
```ts
45+
import { encrypt, decrypt } from "@dunkelhaiser/caesar-cipher";
46+
```
47+
48+
With default import
49+
50+
```ts
51+
import CaesarCipher from "@dunkelhaiser/caesar-cipher";
52+
```
53+
4054
Using CommonJS
4155

56+
With default import
57+
58+
```ts
59+
const CaesarCipher = require("@dunkelhaiser/caesar-cipher");
60+
```
61+
62+
With named imports
63+
4264
```ts
43-
const { CaesarCipher } = require("@dunkelhaiser/caesar-cipher");
65+
const { encrypt, decrypt } = require("@dunkelhaiser/caesar-cipher");
4466
```
4567

4668
### Encrypt a string

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.0",
3+
"version": "2.0.1",
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)