add simple readme

Author: excessivecoding

README.md

@@ -0,0 +1,78 @@
+# Remix Crash
+
+A root development `<ErrorBoundary />` for your Remix apps.
+
+![Remix Crash](./assets/screenshot.png)
+
+## Overview
+
+Remix Crash is a development overlay to simplify debugging during your development process.
+
+**Warning**: Remix Crash is still quite recent, use at your own risk.
+
+## Getting Started
+
+### Installation
+
+```bash
+npm install remix-crash
+```
+
+### Setup
+
+#### In `app/root.tsx`
+
+```jsx
+export default function App() {
+  return {
+    /* Your app */
+  };
+}
+
+// Add this line
+export { ErrorBoundary } from "remix-crash";
+```
+
+#### In `app/routes/_remix-crash.jsx`
+
+```jsx
+export { loader, action } from "remix-crash";
+```
+
+#### All set
+
+You should be all set from here.
+
+## Advanced
+
+### Production Error Boundary
+
+While Remix Crash provides a simple Production Error Boundary with less information. You might want to customize that page.
+
+If you choose to do so, you will just need to replace the `<ErrorBoundary />` component in your `app/root.jsx`:
+
+```jsx
+// app/root.jsx
+// 1. Import the ErrorBoundary
+import { DevErrorBoundary } from "remix-crash";
+
+export default function App() {
+  return {
+    /* Your app */
+  };
+}
+
+// 2. Define your custom error boundary while using Remix Crash for development environment
+export function ErrorBoundary({ error }) {
+  if (process.env.NODE_ENV === "development") {
+    return <DevErrorBoundary error={error} />;
+  }
+
+  // here goes your custom production Error Boundary
+  return (
+    <div>
+      <p>Oops something very wrong happened...</p>
+    </div>
+  );
+}
+```

assets/screenshot.png

@@ -1,7 +1,7 @@
 import type { LoaderFunction } from "remix";
 
 export const loader: LoaderFunction = () => {
-  user.test();
+  hello.remix();
   return null;
 };