Add readme example and jsdoc comments

Author: krystofwoldrich

README.md

@@ -1,6 +1,22 @@
 # react-native-console-symbolicator
 
-Make all Errors logged via `console` API readable inside React Native Dev Tools.
+Make all Errors logged via `console` API readable inside React Native DevTools.
+
+![React Native Console Symbolicator Example](./public/example.png)
+
+### From
+
+```
+Error: When reading this error in React Native DevTools, you should see the original source code location instead of the bundle.
+    at action (http://192.168.0.129:8081/example/index.bundle//&platform=ios&dev=true&hot=false&lazy=true&transform.engine=hermes&transform.bytecode=1&transform.routerRoot=app&unstable_transformProfile=hermes-stable:97154:36)
+```
+
+### To
+
+```
+Error: When reading this error in React Native DevTools, you should see the original source code location instead of the bundle.
+    at action (/Users/krystofwoldrich/repos/krystofwoldrich/console-symbolicator/example/src/App.tsx:49:37)
+```
 
 ## Installation
 

example/src/App.tsx

@@ -14,7 +14,7 @@ installConsoleSymbolicator({
 });
 
 const message =
-  'When reading this error in React Native Dev Tools, you should see the original source code location instead of the bundle.';
+  'When reading this error in React Native DevTools, you should see the original source code location instead of the bundle.';
 
 export default function App() {
   const colorScheme = useColorScheme();

public/example.png

@@ -3,9 +3,36 @@ import parseErrorStack from 'react-native/Libraries/Core/Devtools/parseErrorStac
 
 type ConsoleLogFunction = (...args: unknown[]) => void;
 
+/**
+ * Installs a console symbolicator that will symbolicate stack traces in console
+ * logs, making it easier to debug errors in React Native applications.
+ *
+ * This function should be called at the start of your application, typically
+ * in the entry file (e.g., `_layout.tsx` or `App.tsx`).
+ *
+ * @param {Object} options - Configuration options for the symbolicator.
+ * @param {boolean} [options.excludeReactNativeCoreFrames=false] - If set to `true`,
+ *   the symbolicator will drop frames from `node_modules/react-native`
+ *   package. This helps readability of the stack trace, but information
+ *   about the internal React Native Core stack is lost.
+ *
+ * @example
+ * installConsoleSymbolicator({ excludeReactNativeCoreFrames: true });
+ */
 export const installConsoleSymbolicator = ({
   excludeReactNativeCoreFrames = false,
 }: {
+  /**
+   * If set to `true`,
+   * the symbolicator will drop frames from `node_modules/react-native`
+   * package. This helps readability of the stack trace, but information
+   * about the internal React Native Core stack is lost.
+   *
+   * @default false
+   *
+   * @example
+   * installConsoleSymbolicator({ excludeReactNativeCoreFrames: true });
+   */
   excludeReactNativeCoreFrames?: boolean;
 } = {}) => {
   if (!__DEV__) {