Skip to content
This repository has been archived by the owner on Feb 17, 2021. It is now read-only.

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
@Timer
Timer committed May 10, 2017
1 parent a5dc84d commit d32d2f3
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions packages/react-error-overlay/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# `react-error-overlay`

An overlay for displaying stack frames.
`react-error-overlay` is an overlay which displays when there is a runtime error.

# API
## Development

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
When developing within this package, make sure you run `npm start` (or `yarn start`) so that the files are compiled as you work.
This is ran in watch mode by default.

If you would like to build this for production, run `npm run build:prod` (or `yarn build:prod`).<br>
If you would like to build this one-off for development, you can run `NODE_ENV=development npm run build` (or `NODE_ENV=development yarn build`).

0 comments on commit d32d2f3

Please sign in to comment.