adding more methods

Author: rishabhyadavv

README.md

@@ -1,48 +1,274 @@
-# react-native-encryption
+# 📚 **React Native Integration Guide for `rn-encryption` Library**
 
-Encryption
+This guide explains how to directly access methods from the `rn-encryption` library in a **React Native project**, including usage examples for AES, RSA, Hashing, HMAC, Random String, and Base64 utilities.
 
-## Installation
+---
+
+## 📑 **Table of Contents**
+
+1. [Library Installation](#1-library-installation)
+2. [New Architecture required](#2-new_arch_needed)  
+3. [Setup in React Native](#3-setup-in-react-native)  
+4. [Direct Method Import](#4-direct-method-import)  
+5. [API Overview](#5-api-overview)  
+6. [Usage Examples](#6-usage-examples)  
+7. [Troubleshooting](#7-troubleshooting)  
+8. [Best Practices](#8-best-practices)  
+9. [FAQ](#9-faq)  
+
+---
+
+## 🚀 **1. Library Installation**
 
-```sh
-npm install rn-encryption
+### 1.1 **Add Dependency**
+
+Install the library using npm or yarn:
+
+```bash
+npm install rn-encryption --save
+# OR
 yarn add rn-encryption
 ```
+### #2-new_arch_needed
+
+New architecture required. React native >= 0.76.5 Works with Expo **Bare Workflow** & **Vanilla React Native**
+
+### 1.2 **Rebuild the Project**
+
+For Android:
+```bash
+cd android && ./gradlew clean && cd ..
+npx react-native run-android
+```
+
+For iOS:
+```bash
+cd ios && pod install && cd ..
+npx react-native run-ios
+```
+
+---
+
+## ⚙️ **2. Setup in React Native**
+
+No additional configuration is required. The methods can be **directly imported** and used.
+
+---
+
+## 📦 **3. Direct Method Import**
+
+You can directly import the methods you need:
+
+```tsx
+import {
+  encryptAES,
+  decryptAES,
+  encryptRSA,
+  decryptRSA,
+  hashSHA256,
+  hashSHA512,
+  hmacSHA256,
+  generateRandomString,
+  base64Encode,
+  base64Decode,
+} from 'rn-encryption';
+```
+
+Each method can be accessed directly without a default object wrapper.
+
+---
+
+## 📚 **4. API Overview**
+
+### 🔒 **AES Encryption/Decryption**
+- **`encryptAES(data: string, key: string): string`**  
+- **`decryptAES(data: string, key: string): string`**
+
+### 🔑 **RSA Encryption/Decryption**
+- **`encryptRSA(data: string, publicKey: string): string`**  
+- **`decryptRSA(data: string, privateKey: string): string`**
+
+### 🛡️ **SHA Hashing**
+- **`hashSHA256(input: string): string`**  
+- **`hashSHA512(input: string): string`**
+
+### 📝 **HMAC-SHA256**
+- **`hmacSHA256(data: string, key: string): string`**
+
+### 🎲 **Random String Generation**
+- **`generateRandomString(input: number): string`**
+
+### 📝 **Base64 Encoding/Decoding**
+- **`base64Encode(input: string): string`**  
+- **`base64Decode(input: string): string`**
+
+---
+
+## 🛠️ **5. Usage Examples**
+
+### 🔒 **5.1 AES Encryption and Decryption**
+
+```tsx
+import { encryptAES, decryptAES } from 'rn-encryption';
+
+const runAESExample = async () => {
+  try {
+    const plainText = "Hello, AES Encryption!";
+    const key = "1234567890123456"; // Must be 16, 24, or 32 characters
+
+    const encryptedText =  encryptAES(plainText, key);
+    console.log("AES Encrypted Text:", encryptedText);
+
+    const decryptedText =  decryptAES(encryptedText, key);
+    console.log("AES Decrypted Text:", decryptedText);
+  } catch (error) {
+    console.error("AES Error:", error);
+  }
+};
+
+runAESExample();
+```
+
+---
+
+### 🔑 **5.2 RSA Encryption and Decryption**
+
+```tsx
+import { encryptRSA, decryptRSA } from 'rn-encryption';
+
+const runRSAExample = async () => {
+  try {
+    const plainText = "Hello, RSA Encryption!";
+    const publicKey = "YOUR_RSA_PUBLIC_KEY";
+    const privateKey = "YOUR_RSA_PRIVATE_KEY";
+
+    const encryptedText =  encryptRSA(plainText, publicKey);
+    console.log("RSA Encrypted Text:", encryptedText);
+
+    const decryptedText =  decryptRSA(encryptedText, privateKey);
+    console.log("RSA Decrypted Text:", decryptedText);
+  } catch (error) {
+    console.error("RSA Error:", error);
+  }
+};
+
+runRSAExample();
+```
+
+---
+
+### 🛡️ **5.3 SHA Hashing**
+
+```tsx
+import { hashSHA256, hashSHA512 } from 'rn-encryption';
+
+const runHashExample = async () => {
+  const data = "Hash this string";
+
+  const sha256 =  hashSHA256(data);
+  console.log("SHA-256 Hash:", sha256);
+
+  const sha512 =  hashSHA512(data);
+  console.log("SHA-512 Hash:", sha512);
+};
+
+runHashExample();
+```
+
+---
+
+### 📝 **5.4 HMAC-SHA256**
+
+```tsx
+import { hmacSHA256 } from 'rn-encryption';
+
+const runHMACExample = async () => {
+  const message = "Authenticate this";
+  const secretKey = "SecretKey";
+
+  const hmac =  hmacSHA256(message, secretKey);
+  console.log("HMAC-SHA256:", hmac);
+};
+
+runHMACExample();
+```
+
+---
+
+### 🎲 **5.5 Random String Generation**
+
+```tsx
+import { generateRandomString } from 'rn-encryption';
+
+const runRandomStringExample = async () => {
+  const randomString =  generateRandomString(16);
+  console.log("Random String:", randomString);
+};
+
+runRandomStringExample();
+```
 
-## Usage
+---
 
+### 📝 **5.6 Base64 Encoding/Decoding**
 
-```js
-import {encrypt, decrypt} from "rn-encryption"
+```tsx
+import { base64Encode, base64Decode } from 'rn-encryption';
 
-// ...
-const encryptionKey = "1234567890123456";
+const runBase64Example = () => {
+  const plainText = "Base64 this text";
 
-  const handleEncryption = async () => {
-   
-    try {
-      const encrypted = await encrypt("sometexthere", encryptionKey);
+  const encoded = base64Encode(plainText);
+  console.log("Base64 Encoded:", encoded);
 
-      const decrypted = await decrypt(encrypted, encryptionKey);
+  const decoded = base64Decode(encoded);
+  console.log("Base64 Decoded:", decoded);
+};
 
-      console.log(`Encrypted: ${encrypted}\nDecrypted: ${decrypted}`);
-    } catch (err) {
-       console.log('An error occurred during encryption/decryption.');
-    }
-  };
+runBase64Example();
 ```
 
-## I have just started to working on this repo
-#I am creating encryption on native side i.e kotlin and objective-C using the turbo modules
+---
+
+## 🐞 **6. Troubleshooting**
 
-## Contributing
+1. **Library Not Found:**  
+   - Run `npx react-native link rn-encryption`.
+   - Clean and rebuild the project.
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+2. **AES Key Size Error:**  
+   - Ensure the AES key is **16, 24, or 32 characters**.
 
-## License
+3. **RSA Key Parsing Issue:**  
+   - Verify the RSA key is in **Base64-encoded PEM format**.
 
-MIT
+4. **Permission Issues:**  
+   - Ensure native permissions are set correctly in **AndroidManifest.xml** or **iOS Podfile**.
 
 ---
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+## ✅ **7. Best Practices**
+
+1. **Do Not Hardcode Keys:** Use `.env` or secure storage for keys.
+2. **Handle Errors Gracefully:** Wrap calls in `try-catch` blocks.
+3. **Validate Key Sizes:** Ensure AES and RSA keys meet size requirements.
+
+---
+
+## ❓ **8. FAQ**
+
+**Q: Does the library support both Android and iOS?**  
+A: Partially, `rn-encryption` fully supports ios and encryptAES & decryptAES for Android platforms.
+
+**Q: Can I use the library in Expo?**  
+A: Yes, if you're using **Expo Bare Workflow**.
+
+**Q: How do I debug encryption issues?**  
+A: Add console logs and verify that keys and data are correctly passed.
+
+---
+
+##  **9. Conclusion**
+
+With **`rn-encryption`**, you can securely handle encryption, hashing, and cryptographic operations in your React Native app. Use the examples above to integrate and test various functionalities.
+