docs: update documentation

Author: vgbr-dev

README.md

@@ -1,6 +1,19 @@
 # CryptoDriver
 
-CryptoDriver is a simple and easy-to-use encryption library for JavaScript applications. It provides a way to encrypt and decrypt data using the Advanced Encryption Standard (AES) algorithm with a user-provided key 🔑.
+The `CryptoDriver` is a simple and easy-to-use encryption class, manages cipher and decipher of data using the Advanced Encryption Standard (AES) `AES-256-GCM` algorithm with a user-provided key. This algorithm uses a 256-bit key and is considered one of the most secure symmetric encryption algorithms available.
+
+## Table of Contents
+
+- [Installation](##Installation)
+- [Importing](##Importing)
+- [Usage](##Usage)
+- [API](##API)
+  - [CryptoDriver(key)](###CryptoDriver(key))
+  - [CryptoDriver#encrypt(data)](###CryptoDriver#encrypt(data))
+  - [CryptoDriver#decrypt(encrypted)](###CryptoDriver#decrypt(encrypted))
+- [Security Considerations](##Security-Considerations)
+- [Contributing](##Contributing)
+- [License](##License)
 
 ## Installation
 
@@ -22,30 +35,113 @@ import CryptoDriver from 'crypto-driver';
 const CryptoDriver = require('crypto-driver');
 ```
 
-## Overview
-
-### Create instance
+## Usage
 
-Then, create a new instance of the CryptoDriver class with your encryption key:
+The `CryptoDriver` module is a class that needs to be instantiated with a key before it can be used. Once instantiated, you can use the `encrypt()` and `decrypt()` methods to encrypt and decrypt data.
 
 ```js
-const key = 'e79b44ab0dbb6934385921e95aaaf67fa88e61c0a0ca44f841da3729604ef62a145be70de13ed1';
-const cryptoDriver = new CryptoDriver(key);
+const CryptoDriver = require('crypto-driver');
+
+const key = 'd6F3Efeqd6F3Efeqd6F3Efeqd6F3Efeq';
+const crypto = new CryptoDriver(key);
+
+const data = 'This is my secret message';
+
+// Encrypt the original data
+const encrypted = crypto.encrypt(data);
+
+// Decrypt the encrypted data
+const decrypted = crypto.decrypt(encrypted);
+
+console.log(data); // This is my secret message
+console.log(encrypted); // 2fV+Hd1vN6rByYjKsNixNl2eDvUJziG/6kKj8zJb+zk=BvLrZrTjTxbV6QAAAAA
+console.log(decrypted ); // This is my secret message
+
 ```
 
-### Use methods
+## API
 
-You can then use the encrypt and decrypt methods to encrypt and decrypt data, respectively:
+### `CryptoDriver(key)`
+
+Creates an instance of the CryptoDriver class.
+
+Arguments
+
+| Name  | Type     | Description                                                                        |
+|-------|----------|------------------------------------------------------------------------------------|
+| `key` | `string` | The `key` used for encryption and decryption. Must be a `string` of 32 characters. |
+
+Throws
+
+| Type             | Description                                            |
+|------------------|--------------------------------------------------------|
+| `ReferenceError` | If the `key` value is `undefined`.                     |
+| `TypeError`      | If the `key` value is not a `string`.                  |
+| `RangeError`     | If the length of the `key` value is not 32 characters. |
+
+Example
 
 ```js
-const plaintext = 'Hello, world!';
-const ciphertext = cryptoDriver.encrypt(plaintext);
-const decryptedText = cryptoDriver.decrypt(ciphertext);
-console.log(decryptedText); // Output: Hello, world!
+const CryptoDriver = require('crypto-driver');
+
+const key = 'd6F3Efeqd6F3Efeqd6F3Efeqd6F3Efeq';
+const crypto = new CryptoDriver(key);
+```
+
+### `CryptoDriver#encrypt(data)`
 
+Encrypts the specified data using the AES-256-GCM encryption algorithm.
+
+Arguments
+
+| Name   | Type     | Description                                   |
+|--------|----------|-----------------------------------------------|
+| `data` | `string` | The data to be encrypted. Must be a `string`. |
+
+Returns
+
+A `string` representing the encrypted data.
+
+Throws
+
+| Type             | Description                            |
+|------------------|----------------------------------------|
+| `ReferenceError` | If the `data` value is `undefined`.    |
+| `TypeError`      | If the `data` value is not a `string`. |
+
+Example
+
+```js
+const encrypted = crypto.encrypt('This is my secret message');
 ```
 
-See [documentation](https://github.com/vgbr-dev/crypto-driver/wiki#cryptodriver) for more details.
+### `CryptoDriver#decrypt(encrypted)`
+
+Decrypts the specified encrypted data using the AES-256-GCM encryption algorithm.
+
+Arguments
+
+| Name        | Type     | Description                                             |
+|-------------|----------|---------------------------------------------------------|
+| `encrypted` | `string` | The encrypted data to be decrypted. Must be a `string`. |
+
+Returns
+
+A `string` representing the decrypted data.
+
+Throws
+
+| Type             | Description                                 |
+|------------------|---------------------------------------------|
+| `ReferenceError` | If the `encrypted` value is `undefined`.    |
+| `TypeError`      | If the `encrypted` value is not a `string`. |
+
+Example
+
+```js
+const encrypted = crypto.encrypt('This is my secret message');
+const decrypted = crypto.decrypt(encrypted);
+```
 
 ## Security Considerations