From 42bf0958fdb920f36b33dfaa4224445e1dd0e9f1 Mon Sep 17 00:00:00 2001 From: Bobby Galli Date: Wed, 17 Aug 2022 13:23:14 -0400 Subject: [PATCH] chore: update README.md Fixes #32 --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6ae4f1f..273b924 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ -[![BugSplat](https://s3.amazonaws.com/bugsplat-public/npm/header.png)](https://www.bugsplat.com) +[![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)](https://bugsplat.com) +
+#
BugSplat
+### **
Crash and error reporting built for busy developers.
** +
+ + Follow @bugsplatco on Twitter + + + Join BugSplat on Discord + +
-# stack-converter +# 🥞 stack-converter `stack-converter` is a utility for translating function names, file names and line numbers in uglified JavaScript Error stack frames to the corresponding values in the original source. `stack-converter` is distributed as both a package and a library and is used by the [BugSplat](https://www.bugsplat.com) backend to deliver crash reporting as a service for JavaScript and TypeScript applications. The following is an example JavaScript Error stack converted to its TypeScript equivalent using `stack-converter`: @@ -19,7 +30,7 @@ Error: BugSplat rocks! at Object. (../../bin/cmd.ts:12:2) ``` -## Command Line +## 🖥 Command Line 1. Install this package globally `npm i -g @bugsplat/stack-converter` 2. Run `stack-converter -h` to see the latest usage information: ```bash @@ -38,7 +49,7 @@ bobby@BugSplat % ~ % stack-converter -h ``` 3. Run `stack-converter` and optionally specify a path to a directory containing .map files, path to a single .map file, and a path to a .txt file containing a stringified JavaScript Error. If no options are provided `stack-converter` will default to looking in the current directory for source maps and attempt to read the stringified JavaScript error stack from the system clipboard. -## API +## 🧩 API 1. Install this package locally `npm i @bugsplat/stack-converter` 2. Import `StackConverter` from `@bugsplat/stack-converter` ```ts