From 1a6c9289513d5908c784e7434865f64dcee95124 Mon Sep 17 00:00:00 2001 From: "Jeffrey C. Ollie" Date: Mon, 2 Sep 2024 15:19:03 -0500 Subject: [PATCH] update README --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a3c3a9055..2667b7dc5 100644 --- a/README.md +++ b/README.md @@ -459,16 +459,17 @@ crash report was generated. > [!NOTE] > -> A future version of Ghostty will make the crash reports more easily -> viewable through the CLI and GUI. For now, you must manually check the -> directory. +> Use the `ghostty +crash-report` CLI command to get a list of available crash +> reports. A future version of Ghostty will make the contents of the crash +> reports more easily viewable through the CLI and GUI. -Crash reports end in the `.ghosttycrash` extension. The crash reports are -in [Sentry envelope format](https://develop.sentry.dev/sdk/envelopes/). You -can upload these to your own Sentry account to view their contents, but the -format is also publicly documented so any other available tools can also -be used. A future version of Ghostty will show you the contents of the -crash report directly in the terminal. +Crash reports end in the `.ghosttycrash` extension. The crash reports are in +[Sentry envelope format](https://develop.sentry.dev/sdk/envelopes/). You can +upload these to your own Sentry account to view their contents, but the format +is also publicly documented so any other available tools can also be used. +The `ghostty +crash-report` CLI command can be used to list any crash reports. +A future version of Ghostty will show you the contents of the crash report +directly in the terminal. If Ghostty crashed, you can help the project by sending the crash report to a maintainer. We do not recommend uploading crash reports directly