Skip to content

Commit cc2edef

Browse files
committed
docs
1 parent 5079f32 commit cc2edef

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

docs/decrypt.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Decryption
2+
3+
## Importing
4+
```js
5+
const {Decrypt} = require('text-encryption-tool')
6+
```
7+
## Decrypting
8+
```js
9+
const text = "hMGbwUXZwYHICZ3TgADITRGITRWQ5BCLhYzZnN2V";
10+
const key = "==QbsNGcuhUZnh2aUNXavFGQCdWZ290VjxWQ1l3UkZDM";
11+
const output = Decrypt(text,key); // Decrypting the Text.
12+
console.log(output); // logging the output.
13+
```
14+
#### Example Output
15+
```js
16+
{
17+
text: "Hello!, This is a npm package!"
18+
}
19+
```

docs/encrypt.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Encryption
2+
3+
## Importing
4+
```js
5+
const {Encrypt} = require('text-encryption-tool')
6+
```
7+
## Encrypting
8+
```js
9+
const text = `Hello!, This is a npm package!`; // Text to Encrypt.
10+
const output = Encrypt(text); // Encrypting the Text.
11+
console.log(output); //logging the encrypted Text.
12+
```
13+
#### Example Output
14+
```js
15+
{
16+
text: "hMGbwUXZwYHICZ3TgADITRGITRWQ5BCLhYzZnN2V",
17+
key: "==QbsNGcuhUZnh2aUNXavFGQCdWZ290VjxWQ1l3UkZDM"
18+
}
19+
```

docs/formatting.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Formatting
2+
- `\n` is turned into space.
3+
- Having Disallowed Characters will throw an error.
4+
## Valid Characters
5+
- AlphaNumeric Characters

0 commit comments

Comments
 (0)