diff --git a/README.md b/README.md index 301e3a2..7aaf1b7 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] -![](./dark-mode.png) +![](./assets/banner.png) ## What is Youch? @@ -19,13 +19,21 @@ As you can see in the following screenshots, the Youch output deconstructs the e Raw stack trace - - Youch output - + + + + + + Youch Output + + + + + @@ -68,13 +76,7 @@ Let's de-construct the error page and understand what each section of the web pa ### Error info - - - - - - -
+![](./assets/error-info.png) The top-most section displays the Error info, which includes: @@ -88,19 +90,19 @@ See: [How to override the Error info template]() The Stack trace section displays individual frames as accordion sections and clicking on the section title will reveal the frame source code. The soure code is not available for native stack frames that are part of the Node.js, Deno, and Bun internals. -![](./error-stack.png) +![](./assets/error-stack.png) Clicking the `Raw` button displays the Error object in its raw form with all the error properties (and not just the stack trace). You might find the raw output helpful for errors that contains additional properties. For example: HTTP client libraries like Axios, Got, Undici and others usually contain the HTTP response details within the error object. -![](./stack-raw-output.png) +![](./assets/stack-raw-output.png) ### Error cause [Error cause](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause) is a standard way to bubble errors while wrapping them within a generic error. Youch displays the error cause as an interactive property within its own section. -![](./error-cause.png) +![](./assets/error-cause.png) ### Metadata diff --git a/dark-mode.png b/assets/banner.png similarity index 100% rename from dark-mode.png rename to assets/banner.png diff --git a/error-cause.png b/assets/error-cause.png similarity index 100% rename from error-cause.png rename to assets/error-cause.png diff --git a/error-info.png b/assets/error-info.png similarity index 100% rename from error-info.png rename to assets/error-info.png diff --git a/error-stack.png b/assets/error-stack.png similarity index 100% rename from error-stack.png rename to assets/error-stack.png diff --git a/raw-stack-trace.png b/assets/raw-stack-trace.png similarity index 100% rename from raw-stack-trace.png rename to assets/raw-stack-trace.png diff --git a/stack-raw-output.png b/assets/stack-raw-output.png similarity index 100% rename from stack-raw-output.png rename to assets/stack-raw-output.png diff --git a/assets/youch-output.jpg b/assets/youch-output.jpg new file mode 100644 index 0000000..38ef548 Binary files /dev/null and b/assets/youch-output.jpg differ diff --git a/youch-output.png b/youch-output.png deleted file mode 100644 index 4b2e7a8..0000000 Binary files a/youch-output.png and /dev/null differ diff --git a/youch_raw_diff.jpg b/youch_raw_diff.jpg deleted file mode 100644 index 1783ae1..0000000 Binary files a/youch_raw_diff.jpg and /dev/null differ