Skip to content

Commit 90c716a

Browse files
committed
docs
1 parent 93818bd commit 90c716a

File tree

5 files changed

+14
-64
lines changed

5 files changed

+14
-64
lines changed

README.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,9 @@ An Open-source strong Text Encryption Tool
1010
- This Project is available as npm package at [text-encryption-tool](https://npmjs.com/package/text-encryption-tool)
1111
---
1212

13-
## Usage
14-
15-
1. Encryption
16-
```js
17-
const tes = require('text-encryption-tool');
18-
19-
console.log(tes.encrypt("This is a string"))
20-
```
21-
- output
22-
```js
23-
{
24-
text: "encrypted text",
25-
password: "password of the text"
26-
}
27-
```
28-
2. Decryption
29-
```js
30-
const tes = require('text-encryption-tool');
31-
console.log(tes.decrypt('Encrypted Text','password'))
32-
```
33-
- output
34-
```js
35-
{
36-
text: "decrypted text"
37-
}
38-
```
39-
40-
---
13+
## Documentation
14+
- https://text-encryption-tool.js.org
4115

16+
## Discord
17+
- https://discord.com/invite/xS8b8jQZZK
4218
### Made with ❤️ by [TanvishGG](https://github.com/TanvishGG)

docs/formatting.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ An Open-source strong Text Encryption Tool
88
- Nothing is stored during the encryption process
99

1010
- This Project is available as npm package at [text-encryption-tool](https://npmjs.com/package/text-encryption-tool)
11-
---
11+
12+
- Alphanumeric Characters only!
1213

1314
## Installing
1415
```
@@ -18,6 +19,8 @@ npm install text-encryption-tool@latest
1819
## Docs
1920
1. [Encryption](./encrypt)
2021
2. [Decryption](./decrypt)
21-
3. [Valid Characters and formats](./formatting)
22+
23+
## Discord
24+
- https://discord.com/invite/xS8b8jQZZK
2225

2326
### Made with ❤️ by [TanvishGG](https://github.com/TanvishGG)

src/README.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,9 @@ An Open-source strong Text Encryption Tool
1010
- This Project is available as npm package at [text-encryption-tool](https://npmjs.com/package/text-encryption-tool)
1111
---
1212

13-
## Usage
14-
15-
1. Encryption
16-
```js
17-
const tes = require('text-encryption-tool');
18-
19-
console.log(tes.encrypt("This is a string"))
20-
```
21-
- output
22-
```js
23-
{
24-
text: "encrypted text",
25-
password: "password of the text"
26-
}
27-
```
28-
2. Decryption
29-
```js
30-
const tes = require('text-encryption-tool');
31-
console.log(tes.decrypt('Encrypted Text','password'))
32-
```
33-
- output
34-
```js
35-
{
36-
text: "decrypted text"
37-
}
38-
```
39-
40-
---
13+
## Documentation
14+
- https://text-encryption-tool.js.org
4115

16+
## Discord
17+
- https://discord.com/invite/xS8b8jQZZK
4218
### Made with ❤️ by [TanvishGG](https://github.com/TanvishGG)

src/functions/encrypt.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ const key64 = encodeToBase64(key)
7070
const final = reverseString(encodeToBase64(preText))
7171
return {
7272
text:final,
73-
password: reverseString(key64)
73+
key: reverseString(key64)
7474
}
7575
};
7676

0 commit comments

Comments
 (0)