PNAPL-310: Fix broken link in readme to Rollbar API documentation (#11)

babbel · Oct 20, 2023 · 4bc48d8 · 4bc48d8
1 parent 6e64a37
commit 4bc48d8
Show file tree

Hide file tree

Showing 6 changed files with 797 additions and 589 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.0.6
+
+- Fix broken link in readme to Rollbar API documentation
+- Update dependencies to latest
+
 ## 2.0.5
 
 - Added NPM script `validate:types` to `package.json` which uses package `@arethetypeswrong/cli` to validate that the TypeScript types published with this package are usable by consumers of this package

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Tiny, modern Rollbar TypeScript client whose code is mostly lazy-loaded if and w
 
 ## Background and Overview
 
-This project started as an idea: "Why does an error reporting library need to load at all before an error happens? Can't we defer loading it until an error object is received? If an error never happens, why waste the bandwidth?"; apparently, I talk to myself more than I realize. Following this thought, I attempted to get lazy-loading working with the official Rollbar JS client; doing so ended up being ultimately impossible without major retooling unless I was OK with errors being reported with no details (hint: I'm not). Then I wondered whether Rollbar had an open API with documentation allowing me to write my own client; [they do](https://explorer.docs.rollbar.com/)! Thus, I proceeded to look through the official JavaScript client's source code and API documentation so all the most important features were retained.
+This project started as an idea: "Why does an error reporting library need to load at all before an error happens? Can't we defer loading it until an error object is received? If an error never happens, why waste the bandwidth?"; apparently, I talk to myself more than I realize. Following this thought, I attempted to get lazy-loading working with the official Rollbar JS client; doing so ended up being ultimately impossible without major retooling unless I was OK with errors being reported with no details (hint: I'm not). Then I wondered whether Rollbar had an open API with documentation allowing me to write my own client; [they do](https://docs.rollbar.com/reference/getting-started-1)! Thus, I proceeded to look through the official JavaScript client's source code and API documentation so all the most important features were retained.
 
 This project's code has been used on production since November 2019 for all of our monitored applications, so we're confident it works well.