chore: updated depenciees]

cmcWebCode40 · cmcWebCode40 · commit d723fd912728 · 2025-07-14T13:13:59.000+01:00
diff --git a/README.md b/README.md
@@ -1,24 +1,212 @@
-# react-native-api-debugger
+# React Native API Debugger
 
-API logger/visualizer for react native mobile application
+A comprehensive network request debugging tool for React Native applications. Monitor, inspect, and debug all your app's network requests with an intuitive overlay interface.
+
+[![Version](https://img.shields.io/npm/v/react-native-api-logger)](https://www.npmjs.com/package/react-native-api-logger)
+[![License](https://img.shields.io/npm/l/react-native-api-logger)](https://github.com/your-username/react-native-api-logger/blob/main/LICENSE)
+[![Platform](https://img.shields.io/badge/platform-react--native-blue)](https://reactnative.dev/)
+
+
+
+<img
+  src="/demo/demo_RN_logger.png"
+  alt="Alt text"
+  title="React Native API Logger"
+  style="margin:0 4px; width: 200px"
+/>
+
+
+## Features
+
+- **Real-time Network Monitoring** - Automatically intercepts all fetch() and XMLHttpRequest calls
+- **Overlay Interface** - Non-intrusive floating button and modal interface
+- **Request Details** - View headers, body, response, timing, and status codes
+- **cURL Generation** - Copy requests as cURL commands for debugging
+-  **Request Filtering** - Search and filter by URL, method, or API endpoints
+- **Error Tracking** - Easily identify failed requests and network errors
+- **Device Shake Support** - Optional shake-to-show functionality
 
 ## Installation
 
-```sh
+```bash
 npm install react-native-api-debugger
 ```
 
-## Usage
+### Peer Dependencies
+
+This package requires the following peer dependencies:
+
+```bash
+npm install @react-native-clipboard/clipboard react-native-shake react-native-svg
+```
+
+
+## Quick Start
+
+### Basic Usage
+
+```typescript
+import React, { useEffect } from 'react';
+import { View } from 'react-native';
+import { networkLogger, NetworkLoggerOverlay } from 'react-native-api-debugger';
+
+export default function App() {
+  useEffect(() => {
+    // Initialize the network logger
+    networkLogger.setupInterceptor();
+  }, []);
 
+  return (
+    <View style={{ flex: 1 }}>
+      {/* Your app content */}
+      
+      {/* Add the network logger overlay */}
+      <NetworkLoggerOverlay networkLogger={networkLogger} />
+    </View>
+  );
+}
+```
+
+### With Device Shake Support
+
+```typescript
+import React, { useEffect } from 'react';
+import { View } from 'react-native';
+import { networkLogger, NetworkLoggerOverlay } from 'react-native-api-debugger';
+
+export default function App() {
+  useEffect(() => {
+    networkLogger.setupInterceptor();
+  }, []);
+
+  return (
+    <View style={{ flex: 1 }}>
+      {/* Your app content */}
+      
+      {/* Enable shake-to-show functionality */}
+      <NetworkLoggerOverlay 
+        networkLogger={networkLogger} 
+        enableDeviceShake={true}
+      />
+    </View>
+  );
+}
+```
+
+
+### NetworkLoggerOverlay
+
+The UI component that displays the network logs.
+
+#### Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `networkLogger` | `NetworkLogger` | **Required** | The network logger instance |
+| `enableDeviceShake` | `boolean` | `false` | Enable shake-to-show functionality |
+
+#### Example
+
+```typescript
+<NetworkLoggerOverlay 
+  networkLogger={networkLogger}
+  enableDeviceShake={true}
+/>
+```
 
-```js
-import { multiply } from 'react-native-api-debugger';
+### Types
 
-// ...
+The package exports TypeScript types for better development experience:
 
-const result = await multiply(3, 7);
+```typescript
+import type { 
+  NetworkLog, 
+  NetworkResponse, 
+  NetworkRequestHeaders,
+  LogListener 
+} from 'react-native-api-debugger';
 ```
 
+## Usage Examples
+
+### Development vs Production
+
+```typescript
+import { networkLogger, NetworkLoggerOverlay } from 'react-native-api-debugger';
+
+export default function App() {
+  useEffect(() => {
+    // Only enable in development
+    if (__DEV__) {
+      networkLogger.setupInterceptor();
+    }
+  }, []);
+
+  return (
+    <View style={{ flex: 1 }}>
+      {/* Your app content */}
+      
+      {/* Only show in development */}
+      {__DEV__ && (
+        <NetworkLoggerOverlay 
+          networkLogger={networkLogger}
+          enableDeviceShake={true}
+        />
+      )}
+    </View>
+  );
+}
+```
+
+## Best Practices
+
+### 1. Development Only
+
+```typescript
+// Only enable in development builds
+if (__DEV__) {
+  networkLogger.setupInterceptor();
+}
+```
+
+### 2. Memory Management
+
+The logger automatically limits stored requests to prevent memory issues:
+- Maximum 100 requests stored
+- Oldest requests are automatically removed
+
+### 3. Sensitive Data
+
+Be cautious with sensitive data in network requests:
+- The logger captures all headers and request/response bodies
+- Consider disabling in production builds
+- Review logged data before sharing screenshots
+
+
+### TypeScript Errors
+
+1. Ensure you're importing types correctly:
+```typescript
+import type { NetworkLog } from 'react-native-api-logger';
+```
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Support
+
+- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/your-username/react-native-api-logger/issues)
+- 💡 **Feature Requests**: [GitHub Discussions](https://github.com/your-username/react-native-api-logger/discussions)
+- 📖 **Documentation**: [Wiki](https://github.com/your-username/react-native-api-logger/wiki)
+
+---
+
+**Made with ❤️ for React Native developers**
 
 ## Contributing
 
diff --git a/package.json b/package.json
@@ -64,6 +64,7 @@
     "@eslint/eslintrc": "^3.3.0",
     "@eslint/js": "^9.22.0",
     "@evilmartians/lefthook": "^1.5.0",
+    "@react-native-clipboard/clipboard": "^1.16.3",
     "@react-native/babel-preset": "0.78.2",
     "@react-native/eslint-config": "^0.78.0",
     "@release-it/conventional-changelog": "^9.0.2",
@@ -79,6 +80,7 @@
     "react": "19.0.0",
     "react-native": "0.79.5",
     "react-native-builder-bob": "^0.37.0",
+    "react-native-shake": "^6.7.8",
     "release-it": "^17.10.0",
     "typescript": "^5.8.3"
   },
diff --git a/yarn.lock b/yarn.lock
@@ -2899,6 +2899,23 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@react-native-clipboard/clipboard@npm:^1.16.3":
+  version: 1.16.3
+  resolution: "@react-native-clipboard/clipboard@npm:1.16.3"
+  peerDependencies:
+    react: ">= 16.9.0"
+    react-native: ">= 0.61.5"
+    react-native-macos: ">= 0.61.0"
+    react-native-windows: ">= 0.61.0"
+  peerDependenciesMeta:
+    react-native-macos:
+      optional: true
+    react-native-windows:
+      optional: true
+  checksum: 3d9944fc2c4acbecf917e752cc36ec92c4dcdb590c94c81c78c24df9ddd4b02448e252eb39e0949000b01046cfdfe2b03e1676c5e3ac0fe7eb3bf6b649970c27
+  languageName: node
+  linkType: hard
+
 "@react-native/assets-registry@npm:0.79.5":
   version: 0.79.5
   resolution: "@react-native/assets-registry@npm:0.79.5"
@@ -11380,6 +11397,7 @@ __metadata:
     "@eslint/eslintrc": ^3.3.0
     "@eslint/js": ^9.22.0
     "@evilmartians/lefthook": ^1.5.0
+    "@react-native-clipboard/clipboard": ^1.16.3
     "@react-native/babel-preset": 0.78.2
     "@react-native/eslint-config": ^0.78.0
     "@release-it/conventional-changelog": ^9.0.2
@@ -11395,6 +11413,7 @@ __metadata:
     react: 19.0.0
     react-native: 0.79.5
     react-native-builder-bob: ^0.37.0
+    react-native-shake: ^6.7.8
     release-it: ^17.10.0
     typescript: ^5.8.3
   peerDependencies:
@@ -11497,6 +11516,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"react-native-shake@npm:^6.7.8":
+  version: 6.7.8
+  resolution: "react-native-shake@npm:6.7.8"
+  peerDependencies:
+    react: "*"
+    react-native: "*"
+  checksum: a0d12169c1d5477a38751b6a555efd067f4f2a997d9151817e0ccb87b0df05361f4868d58945cc7fea260cb7fb36cf8c2112cbb716eb7594ed2c1e2ba046f7f7
+  languageName: node
+  linkType: hard
+
 "react-native-web@npm:~0.20.0":
   version: 0.20.0
   resolution: "react-native-web@npm:0.20.0"
