@honeybadger-io/react - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

CHANGELOG.md

@@ -9,3 +9,6 @@ # Changelog
 
+## [0.0.2] - 2019-01-21
+* Add TypeScript definition
+
 ## [0.0.1] - 2018-11-30
 * Initial release

package.json

 {
   "name": "@honeybadger-io/react",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "React.js integration for honeybadger",
@@ -12,2 +12,3 @@ "author": "Jason Truesdell <[e-mail]> (https://github.com/JasonTrue)",
   "main": "dist/honeybadger-react.cjs.js",
+  "types": "./honeybadger-react.d.ts",
   "module": "dist/honeybadger-react.esm.js",
@@ -14,0 +15,0 @@ "unpkg": "dist/honeybadger-react.js",

README.md

@@ -34,3 +34,4 @@ # Honeybadger React.js Integration
 
-This project is built using a webpack-based React template. It's possible
+This project is built using create-react-library with rollup and generates
+artifacts in commonjs, esm and umd formats. It's possible
 your own build environment may be just different enough to require some
@@ -58,25 +59,32 @@ adjustments. If you find that our artifacts don't quite meet your needs,
 
-# Serve the demo app with hot reload at localhost:8080
-HONEYBADGER_API_KEY=yourkey yarn run dev
+# build for production
+yarn build
 
-# build for production with minification
-yarn run build
+# run unit tests
+yarn test
 
-# build for production and view the bundle analyzer report
-yarn run build --report
+# automatically continuously rebuild the dist/ artifacts with hot reload when developing
+yarn start
+```
 
-# run unit tests
-yarn run unit
+## Example app
 
-# run e2e tests
-HONEYBADGER_API_KEY=yourkey yarn run e2e
+There's a minimal implementation of a honeybadger-react integration in the ./example
+folder. If you want to contribute a patch to honeybadger-react, it can be useful to have
+the demo app running.
 
-# run all tests
-HONEYBADGER_API_KEY=yourkey yarn test:all
+To run it, issue these commands from your shell:
+
+```bash
+cd example
+yarn install
+REACT_APP_HONEYBADGER_API_KEY=b425b636 yarn start
 ```
 
-For a detailed explanation on how things work, check out the [guide](http://reactjs-templates.github.io/webpack/) and [docs for react-loader](http://reactjs.github.io/react-loader).
+This will serve the demo app with hot reload at localhost:3000
 
+For a detailed explanation on how hot reloading works, check out the [guide](http://reactjs-templates.github.io/webpack/) and [docs for react-loader](http://reactjs.github.io/react-loader).
+
 ### License
 
 *honeybadger-react* is MIT licensed. See the [LICENSE](https://raw.github.com/honeybadger-io/honeybadger-react/master/LICENSE) file in this repository for details.

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27579

increased by1.29%

Number of lines in readme file

89

increased by9.88%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes