-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update supercrypt.js package and README.md
- Loading branch information
1 parent
c5d4ba8
commit 69d7b8a
Showing
2 changed files
with
38 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,39 @@ | ||
# supercrypt.js | ||
|
||
🎉 modern numeric-ascii encryption & decryption package | ||
|
||
[![NPM](https://nodei.co/npm/supercrypt.js.png)](\[https:/nodei.co/npm/supercrypt.js) | ||
|
||
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7dd9288acdc94dacaa11ad80f36a9bd3)](https://www.codacy.com/gh/supercrypt.js/dashboard?utm\_source=github.com\&utm\_medium=referral\&utm\_content=supercrypt.js\&utm\_campaign=Badge\_Grade) [![Downloads](https://img.shields.io/npm/dt/supercrypt.js.svg?color=3884FF)](https://www.npmjs.com/package/supercrypt.js) [![Version](https://img.shields.io/npm/v/supercrypt.js.svg?color=3884FF\&label=version)](https://www.npmjs.com/package/supercrypt.js) [![install size](https://packagephobia.com/badge?p=supercrypt.js)](https://packagephobia.com/result?p=supercrypt.js) ![node](https://img.shields.io/node/v/supercrypt.js) | ||
|
||
---- | ||
|
||
## 📦 Installation | ||
```bash | ||
npm install supercrypt.js | ||
# or | ||
yarn add supercrypt.js | ||
# or | ||
pnpm add supercrypt.js | ||
``` | ||
|
||
## 📖 Usage | ||
```javascript | ||
const { encrypt, decrypt } = require('supercrypt.js'); | ||
|
||
(async () => { | ||
const encrypted = await encrypt('Hello, World!'); | ||
console.log(encrypted); | ||
|
||
const decrypted = await decrypt(encrypted); | ||
console.log(decrypted); | ||
})(); | ||
``` | ||
|
||
## 📄 License | ||
Licensed under the [Apache 2.0](https://github.com/binary-blazer/supercrypt.js/blob/main/LICENSE) license. | ||
|
||
## 📝 Author | ||
Made with ❤️ by [Jonas Franke](https://github.com/binary-blazer) | ||
|
||
## 📊 Statistics | ||
![npm](https://img.shields.io/npm/dw/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/stars/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/forks/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/issues/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/license/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/package-json/v/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/last-commit/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/languages/code-size/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/languages/top/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/contributors/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/repo-size/binary-blazer/supercrypt.js?color=3884FF) ![GitHub](https://img.shields.io/github/commit-activity/m/binary-blazer/supercrypt.js?color=3884FF) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters