Added read

Author: a7ul

README.md

@@ -1,2 +1,124 @@
 # react-native-exception-handler
-A react native module to help tackle the exception problem in react native.
+
+A react native module that lets you to register a global error handler that can capture fatal/non fatal uncaught exceptions.
+The module helps prevent abrupt crashing of RN Apps without a graceful message to the user.   
+
+In the current scenario:
+  - `In DEV mode , you get a RED Screen error pointing your JS errors.`
+  - `In Bundled mode , the app just quits without any prompt !` 🙄
+
+To tackle this we register a global error handler that could be used to for example:
+1. Send bug reports to dev team when the app crashes
+2. Show a creative dialog saying the user should restart the application
+
+### Installation:
+
+```sh
+yarn add react-native-exception-handler
+```
+
+or
+
+```sh
+npm i react-native-exception-handler --save
+```
+
+
+### Usage
+
+```js
+import {setJSExceptionHandler} from 'react-native-exception-handler';
+
+.
+.
+.
+
+const errorHandler = (error, isFatal) => {
+  // This is your custom global error handler
+}
+
+.
+.
+.
+
+setJSExceptionHandler(errorHandler); // registering the error handler (maybe u can do this in the index.android.js or index.ios.js)
+
+```
+
+
+### Examples
+
+##### Restart on error example
+
+This example shows how to use this module show a graceful bug dialog to the user on crash and restart the app when the user presses ok !
+
+```js
+import {Alert} from 'react-native';
+import RNRestart from 'react-native-restart';
+import {setJSExceptionHandler} from 'react-native-exception-handler';
+
+const errorHandler = (e, isFatal) => {
+  if (isFatal) {
+    Alert.alert(
+        'Unexpected error occurred',
+        `
+        Error: ${(isFatal) ? 'Fatal:' : ''} ${e.name} ${e.message}
+
+        We will need to restart the app.
+        `,
+      [{
+        text: 'Restart',
+        onPress: () => {
+          RNRestart.Restart();
+        }
+      }]
+    );
+  } else {
+    console.log(e); // So that we can see it in the ADB logs in case of Android if needed
+  }
+};
+
+setJSExceptionHandler(errorHandler);
+```
+
+#### Bug Capture to dev team example
+
+This example shows how to use this module to send global errors to the dev team and show a graceful bug dialog to the user on crash !
+
+```js
+import {Alert} from 'react-native';
+import {BackAndroid} from 'react-native';
+import {setJSExceptionHandler} from 'react-native-exception-handler';
+
+const reporter = (error) => {
+  // Logic for reporting to devs
+  // Example : Log issues to github issues using github apis.
+  console.log(error); // sample
+};
+
+const errorHandler = (e, isFatal) => {
+  if (isFatal) {
+    reporter(e);
+    Alert.alert(
+        'Unexpected error occurred',
+        `
+        Error: ${(isFatal) ? 'Fatal:' : ''} ${e.name} ${e.message}
+
+        We have reported this to our team ! Please close the app and start again!
+        `,
+      [{
+        text: 'Close',
+        onPress: () => {
+          BackAndroid.exitApp();
+        }
+      }]
+    );
+  } else {
+    console.log(e); // So that we can see it in the ADB logs in case of Android if needed
+  }
+};
+
+setJSExceptionHandler(errorHandler);
+```
+
+*More Examples can be found in the examples folder*

package.json

@@ -1,7 +1,8 @@
 {
     "name": "react-native-exception-handler",
     "version": "1.0.0",
-    "description": "A react native module to help tackle the exception problem in react native.",
+    "description": "A react native module that lets you to register a global error handler that can capture fatal/non fatal uncaught exceptions.
+",
     "main": "index.js",
     "scripts": {
       "test": "echo no tests && exit 1",
@@ -18,9 +19,13 @@
         "native",
         "exception",
         "handler",
+        "red",
+        "screen",
         "production",
         "ios",
-        "android"
+        "android",
+        "bug",
+        "capture"
     ],
     "peerDependencies": {
         "react": "*",
@@ -31,16 +36,5 @@
     "bugs": {
         "url": "https://github.com/master-atul/react-native-exception-handler/issues"
     },
-    "homepage": "https://atulr.com/react-native-exception-handler",
-    "bundledDependencies": [
-      "react-native-restart"
-    ],
-    "devDependencies": {
-        "babel-eslint": "^7.1.1",
-        "babel-polyfill": "^6.22.0",
-        "babel-preset-react-native": "^1.9.1",
-        "eslint": "^3.14.1",
-        "eslint-plugin-react": "^6.9.0",
-        "eslint-plugin-react-native": "^2.2.1"
-    }
+    "homepage": "https://atulr.com/react-native-exception-handler"
 }