cupcakearmy/occulto
1
0
Fork 0
mirror of https://github.com/cupcakearmy/occulto.git synced 2025-01-02 12:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Nicco 2019-07-07 21:47:57 +02:00 committed by GitHub
parent 19c6e0c11f
commit 7f2309af02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -6,6 +6,8 @@ Supports Hashes, Symmetric AES & ChaCha20 ciphers and Asymmetric RSA.
**Typescript typings included** **Typescript typings included**
[**📒 DOCS HERE 📒**](https://cupcakearmy.github.io/occulto/index.html)
## Quickstart 🚀 ## Quickstart 🚀
###### Install ###### Install
@ -14,11 +16,9 @@ Supports Hashes, Symmetric AES & ChaCha20 ciphers and Asymmetric RSA.
npm i node-forge occulto npm i node-forge occulto
``` ```
[**📒 DOCS HERE 📒**](https://cupcakearmy.github.io/occulto/index.html)
### Examples ### Examples
## RSA ## [RSA](https://cupcakearmy.github.io/occulto/modules/_rsa_.html)
```typescript ```typescript
const pair = await RSA.gen() const pair = await RSA.gen()
@ -26,7 +26,9 @@ const encrypted = RSA.encrypt('some text', pair.pub)
const decrypted = RSA.decrypt(encrypted, pair.prv) const decrypted = RSA.decrypt(encrypted, pair.prv)
``` ```
## Symmetric ## [Symmetric](https://cupcakearmy.github.io/occulto/modules/_symmetric_.html)
[Available Ciphers](https://cupcakearmy.github.io/occulto/enums/_symmetric_.ciphers.html)
```javascript ```javascript
import { Symmetric } from 'occulto' import { Symmetric } from 'occulto'
@ -35,9 +37,7 @@ const encrypted = Symmetric.encrypt('some string' , 'myPass', Symmetric.Ciphers.
const decrypted = Symmetric.decrypt(encrypted, 'myPadd') const decrypted = Symmetric.decrypt(encrypted, 'myPadd')
``` ```
## Hash ## [Hash](https://cupcakearmy.github.io/occulto/modules/_hash_.html)
<a href="https://cupcakearmy.github.io/occulto/enums/_hash_.hashes.html" target="_blank">Available hashes</a>
[Available hashes](https://cupcakearmy.github.io/occulto/enums/_hash_.hashes.html) [Available hashes](https://cupcakearmy.github.io/occulto/enums/_hash_.hashes.html)