Merge pull request #9 from Dunkelhaiser/dev

Updated documentation

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @dunkelhaiser/caesar-cipher
 
+## 2.0.1
+
+### Patch Changes
+
+- Updated documentation
+
 ## 2.0.0
 
 ### Major Changes

README.md

@@ -31,16 +31,38 @@ bun add @dunkelhaiser/caesar-cipher
 
 ### Importing the Library
 
-Using ESM
+#### Using ESM
+
+With named import
 
 ```ts
 import { CaesarCipher } from "@dunkelhaiser/caesar-cipher";
 ```
 
+With named imports
+
+```ts
+import { encrypt, decrypt } from "@dunkelhaiser/caesar-cipher";
+```
+
+With default import
+
+```ts
+import CaesarCipher from "@dunkelhaiser/caesar-cipher";
+```
+
 Using CommonJS
 
+With default import
+
+```ts
+const CaesarCipher = require("@dunkelhaiser/caesar-cipher");
+```
+
+With named imports
+
 ```ts
-const { CaesarCipher } = require("@dunkelhaiser/caesar-cipher");
+const { encrypt, decrypt } = require("@dunkelhaiser/caesar-cipher");
 ```
 
 ### Encrypt a string

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dunkelhaiser/caesar-cipher",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "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.",
     "private": false,
     "keywords": [