js-caesarcipher 2.0.5 → 2.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,7 +23,16 @@ npm install js-caesarcipher
|
|
|
23
23
|
|
|
24
24
|
# Useage
|
|
25
25
|
|
|
26
|
+
**For node.js enviroment**
|
|
27
|
+
|
|
28
|
+
If you are in node.js enviroment, you need to initalize first
|
|
29
|
+
|
|
30
|
+
```javascript
|
|
31
|
+
const CaesarCipher = require("js-caesarcipher");
|
|
32
|
+
```
|
|
33
|
+
|
|
26
34
|
**Cipher the text**
|
|
35
|
+
|
|
27
36
|
Use the function `new CaesarCipher()` to cipher raw text.
|
|
28
37
|
|
|
29
38
|
Example: "Hello World", after shifting 2 letters will be "Jgnnq Yqtnf"
|
|
@@ -37,8 +46,6 @@ let cipher = new CaesarCipher({
|
|
|
37
46
|
console.log(cipher.result);
|
|
38
47
|
|
|
39
48
|
// For Node.js useage
|
|
40
|
-
const CaesarCipher = require("js-caesarcipher");
|
|
41
|
-
|
|
42
49
|
const cipher = CaesarCipher.cipher({
|
|
43
50
|
"input": "Hello World",
|
|
44
51
|
"shift": 2
|