Skip to content

Commit d32d2f3

Browse files
committed
Update the README
1 parent a5dc84d commit d32d2f3

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed
+7-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# `react-error-overlay`
22

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

5-
# API
5+
## Development
66

7-
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
7+
When developing within this package, make sure you run `npm start` (or `yarn start`) so that the files are compiled as you work.
8+
This is ran in watch mode by default.
9+
10+
If you would like to build this for production, run `npm run build:prod` (or `yarn build:prod`).<br>
11+
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 commit comments

Comments
 (0)