Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions package/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## How to use this package n-krypta

This package allows you to encrypt and decrypt short strings using a key. It is based on the [AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) algorithm.

### Installation

```bash
npm install n-krypta
```

### Usage

```javascript
const crypta = require('n-rypta');

const key = 'my secret key';
const text = 'my secret text';

const encrypted = crypta.encrypt(text, key);
const decrypted = crypta.decrypt(encrypted, key);

\`\`\`

### API

#### encrypt(text, key)

Encrypts the given text using the given key.

#### decrypt(encrypted, key)

Decrypts the given encrypted text using the given key.

### License

MIT

## How to use this package crypta

This package allows you to encrypt and decrypt short strings using a key. It is based on the [AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) algorithm.

### Installation

```bash
npm install n-krypta
```

16 changes: 13 additions & 3 deletions package/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "n-krypta",
"version": "1.0.0",
"description": "A simplle encrypting and decrypting package",
"version": "1.1.0",
"description": "A simple encrypting and decrypting package",
"main": "index.js",
"scripts": {
"start": "npm run build && node build/index.js",
Expand All @@ -23,7 +23,17 @@
"^.+\\.tsx?$": "ts-jest"
}
},
"keywords": [],
"keywords": [
"encrypt",
"decrypt",
"crypto",
"hash",
"hashing",
"encryption",
"decryption",
"n-krypta",
"password"
],
"author": "Samuel Egbajie",
"license": "ISC",
"bugs": {
Expand Down