react-native-proguard-auto 1.0.0 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-proguard-auto",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Automatically generate ProGuard rules for React Native native modules",
   "type": "module",
   "bin": {
@@ -14,4 +14,4 @@
     "javascript-obfuscator": "^5.3.0"
   },
   "license": "MIT"
-}
+}

package/readme.md

@@ -0,0 +1,128 @@
+# react-native-proguard-auto
+
+Automatically generate **ProGuard / R8 rules for React Native projects**.
+
+`react-native-proguard-auto` scans your installed dependencies and generates recommended **ProGuard keep rules** to help prevent **release build crashes caused by code shrinking and obfuscation**.
+
+It simplifies the process of handling ProGuard rules when working with **React Native native modules**.
+
+---
+
+## 🚀 Features
+
+- Automatically scans installed dependencies
+- Generates ProGuard / R8 keep rules
+- Helps prevent release build crashes
+- Works with modern React Native versions
+- Simple CLI usage
+
+---
+
+## 📦 Installation
+
+Install the package inside your React Native project.
+
+### Using npm
+
+npm install --save-dev react-native-proguard-auto
+
+### Using yarn
+
+yarn add --dev react-native-proguard-auto
+
+---
+
+## ⚙️ Usage
+
+After installing the package, run the CLI using **npx**.
+
+npx react-native-proguard-auto
+
+Run this command from the **root of your React Native project**.
+
+The tool will analyze your project dependencies and generate **recommended ProGuard rules**.
+
+---
+
+### 📸 Without Proguard Rules
+
+Without proper ProGuard rules, release builds may fail or crash due to missing classes during code shrinking.
+
+![Without Proguard Rules](./images/before-proguard.png)
+
+---
+
+### 📸 After Using react-native-proguard-auto
+
+The tool automatically generates the required ProGuard rules to help ensure stable release builds.
+
+![After Using react-native-proguard-auto](./images/after-proguard.png)
+
+
+---
+
+## 📄 Example Output
+
+Example generated rules:
+
+-keep class com.reactnativecommunity.** { *; }
+-keep class com.google.firebase.** { *; }
+-keep class com.google.android.gms.** { *; }
+
+You can copy these rules into your Android ProGuard configuration file.
+
+---
+
+## 📂 Where to Add the Rules
+
+Add the generated rules to:
+
+android/app/proguard-rules.pro
+
+Example project structure:
+
+YourProject
+ ├── android
+ │   └── app
+ │       └── proguard-rules.pro
+ ├── node_modules
+ ├── package.json
+
+---
+
+## 🏗 Build Release APK / AAB
+
+After adding the rules, build your release version.
+
+cd android
+gradlew assembleRelease
+
+or
+
+npx react-native run-android --variant=release
+
+---
+
+## 🧑‍💻 Compatibility
+
+Works with:
+
+- React Native 0.60+
+- Android R8
+- Android ProGuard
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome.
+
+If you find a bug or want to improve the tool, feel free to open an issue or submit a pull request.
+
+---
+
+## 📜 License
+
+MIT License
+
+---