diff --git a/README.md b/README.md index 0cc4e74..71d655d 100644 --- a/README.md +++ b/README.md @@ -26,38 +26,12 @@ const decrypted = RSA.decrypt(encrypted, 'myPass') ``` -### Reference 📒 +[**📒 DOCS HERE 📒**](https://cupcakearmy.github.io/occulto/index.html) + +### Examples ## RSA -#### `RSA.gen(size: number = 2 ** 12)` - -- size: [optional, default=4096] Size of the RSA key - -###### Examples - -```javascript -const pair = await RSA.gen() // 4096-Bit -const smallPair = await RSA.gen(2**10) // 1024-Bit -``` - -#### `RSA.encrypt(data: string, key: PublicKey)` - -Encrypt message with public key - -###### Example - -```javascript -const pair = await RSA.gen() -const encrypted = RSA.encrypt('some text', pair.pub) -``` - -#### `RSA.decrypt(data: string, key: PrivateKey)` - -Decrypts a message encrypted with `RSA.encrypt()` with the private key - -###### Example - ```javascript const pair = await RSA.gen() const encrypted = RSA.encrypt('some text', pair.pub) @@ -66,53 +40,22 @@ const decrypted = RSA.decrypt(encrypted, pair.prv) ## Symmetric -### `Symmetric.Ciphers` - -Available ciphers - -- `Ciphers.ChaCha20` -- `Ciphers.AES_256_GCM` -- `Ciphers.AES_192_GCM` -- `Ciphers.AES_128_GCM` -- `Ciphers.AES_256_CTR` -- `Ciphers.AES_192_CTR` -- `Ciphers.AES_128_CTR` - -#### `Symmetric.encrypt(data: string, key: string, type: Ciphers = Ciphers.AES_256_GCM)` - -Encrypts a string. -Defaults to `Ciphers.AES_256_CTR` - -###### Examples - ```javascript -const encrypted = Symmetric.encrypt('some string' , 'myPass') +// Whatever import you prefer +// const { Symmetric } = require('occulto') +import { Symmetric } from 'occulto' -const e = Symmetric.encrypt('some string' , 'myPass', Ciphers.AES_128_GCM) +const encrypted = Symmetric.encrypt('some string' , 'myPass', Symmetric.Ciphers.AES_128_GCM) +const decrypted = Symmetric.decrypt(encrypted, 'myPadd') ``` ## Hash -### `Hash.Hashes` - -Available hashes - -- `Hashes.MD5` -- `Hashes.SHA1_1` -- `Hashes.SHA1_256` -- `Hashes.SHA1_512` -- `Hashes.SHA3_256` -- `Hashes.SHA3_384` -- `Hashes.SHA3_512` - -#### `Hash.digest(s: string, type: Hashes = Hashes.SHA3_256)` - -Calculates the hash of a string. -Defaults to `Hashes.SHA3_256` - -###### Examples - ```javascript +// Whatever import you prefer +// const { Hash } = require('occulto') +import { Hash } from 'occulto' + const hash = Hash.digest('something') const h = Hash.digest('something', Hashes.MD5)