ciphers-gematria 1.0.3 → 2.0.0

package/README.md

@@ -13,12 +13,15 @@ npm install ciphers-gematria
 yarn add ciphers-gematria
 ```
 
-## Calculate all ciphers
+## ⚡ Quick start
 
 ```javascript
-import { ciphers } from 'ciphers-gematria';
+import { ciphers } from 'ciphers-gematria'; // ESM
+const gematria = require('ciphers-gematria'); // CJS
+
+const result = ciphers("hello"); // ESM
+const result = gematria.ciphers("hello"); // CJS
 
-const result = ciphers("hello");
 console.log(result);
 
 // Output:
@@ -60,17 +63,108 @@ console.log(result);
 ---
 
 ## Calculate a single cipher
-
+### ESM
+ ♻️ Only the imported cipher will be included in your final bundle.
 ```javascript
-import { sumerian, chaldean } from 'ciphers-gematria';
+import { sumerian, latin, chaldean } from 'ciphers-gematria'; 
 
 console.log(sumerian('hello')); // 312
-console.log(chaldean('hello')); // 23
+console.log(gematria.chaldean('hello')); // 23
+```
+
+### CJS
+```javascript
+const gematria = require('ciphers-gematria');
+
+console.log(gematria.latin('hello')); // 312
+console.log(gematria.chaldean('hello')); // 23
 ```
 
 ---
-## 🤝Contribution
+## 🛠️ Create a custom cipher
+
+createCipher is a function:
+it returns a new cipher function based on a custom letter-value table.
+
+### ESM
+```javascript
+import { createCipher } from 'ciphers-gematria';
+
+const mySpecialTable = {
+  A: 251, B: 101, C: 45, D:150 ...... Z:42
+};
+const myCustomCipher = createCipher(mySpecialTable); 
+console.log(myCustomCipher('hello')); 
+
+```
+### CJS
+```javascript
+const gematria = require('ciphers-gematria');
+
+const mySpecialTable = {
+  A: 251, B: 101, C: 45, D:150 ...... Z:42
+};
+const myCustomCipher = gematria.createCipher(mySpecialTable); 
+console.log(myCustomCipher('hello')); 
+```
+
+---
+## 📚 Available ciphers
+
+<table style="background-color: #f1f1f1; border-radius: 5px; padding: 5px">
+  <tr s>
+    <td >Ordinal</td>
+    <td >Reduction</td>
+     <td >Reverse</td>
+      <td >Reverse Reduction</td>
+  </tr>
+  <tr>
+    <td>Standard</td>
+    <td >Latin</td>
+     <td >Sumerian</td>
+      <td >Reverse Sumerian</td>
+  </tr>
+    <tr>
+    <td>Capitals Mixed</td>
+    <td >Capitals Added</td>
+    <td >Reverse Capitals Mixed</td>
+     <td >Reverse Capitals Added</td>
+  </tr>
+  <tr>
+    <td>Reverse Standard</td>
+    <td >Satanic</td>
+    <td >Reverse Satanic</td>
+     <td >Single Reduction</td>
+  </tr>
+    <tr>
+    <td>Kv Exception</td>
+    <td >Skv Exception</td>
+    <td >Reverse Single Reduction</td>
+     <td >Ep Exception</td>
+     </tr>
+    <tr>
+      <td>Ehp Exception</td>
+      <td >Primes</td>
+      <td >Trigonal</td>
+      <td >Squares</td>
+    </tr>
+     <tr>
+      <td>Fibonacci</td>
+      <td >Reverse Primes</td>
+      <td >Reverse Trigonal</td>
+      <td >Reverse Squares</td>
+    </tr>
+     <tr>
+      <td>Chaldean</td>
+      <td >Septenary</td>
+      <td >Keypad</td>
+    </tr>
+</table>
+
+---
+### 🤝Contribution
 
 Contributions are welcome! If you’d like to add a new cipher.
 
-Fork the repository and create a pull request.
+Fork the repository and create a pull request
+