update example (#8)

Co-authored-by: Tate <[email protected]>
tatethurston · Jan 20, 2022 · cc4b150 · cc4b150
1 parent e17882e
commit cc4b150
Show file tree

Hide file tree

Showing 10 changed files with 368 additions and 416 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,7 +1,7 @@
 // eslint-disable-next-line no-undef
 module.exports = {
   root: true,
-  ignorePatterns: ["dist", "examples"],
+  ignorePatterns: ["dist", "example"],
   plugins: ["@typescript-eslint"],
   extends: [
     "eslint:recommended",

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 node_modules
 dist/*
-examples/dist/*
-!examples/dist/index.html
+example/dist/*
+!example/dist/index.html
 
diff --git a/README.md b/README.md
@@ -85,7 +85,7 @@ Note that in addition to the hook, the component must be wrapped with `withError
 
 This was done to avoid hooking into React internals, which would otherwise be required. The hope is that the eventual React hook solution will present a similar API, and users can easily migrate by removing the `withErrorBoundary` wrapper.
 
-For a full project example take a look at the [examples directory](https://github.com/tatethurston/react-use-error-boundary/blob/main/examples).
+For a full project example take a look at the [example](https://github.com/tatethurston/react-use-error-boundary/blob/main/example).
 
 ## Known Limitations ⚠️
 
@@ -97,7 +97,7 @@ Because React recreates the component tree from scratch after catching an error,
 
 🎁 Zero run time dependencies
 
-🦶 Small footprint [673 B minified and gzipped](https://bundlephobia.com/[email protected].0)
+🦶 Small footprint [673 B minified and gzipped](https://bundlephobia.com/[email protected].2)
 
 🪐 Isomorphic / Universal -- safe to run in any JS context: the browser or on a server
 

diff --git a/examples/dist/index.html → example/dist/index.html b/examples/dist/index.html → example/dist/index.html
diff --git a/examples/package.json → example/package.json b/examples/package.json → example/package.json
@@ -1,23 +1,23 @@
 {
-  "name": "examples",
+  "name": "example",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "start": "yarn webpack && open dist/index.html"
   },
   "author": "Tate Thurston <[email protected]>",
   "license": "ISC",
   "devDependencies": {
-    "@types/react-dom": "^17.0.3",
-    "ts-loader": "^9.0.0",
-    "typescript": "^4.2.4",
-    "webpack": "^5.34.0",
-    "webpack-cli": "^4.6.0"
+    "@types/react-dom": "^17.0.11",
+    "ts-loader": "^9.2.6",
+    "typescript": "^4.5.5",
+    "webpack": "^5.66.0",
+    "webpack-cli": "^4.9.1"
   },
   "dependencies": {
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
-    "react-use-error-boundary": "^0.0.2"
+    "react-use-error-boundary": "^1.0.2"
   }
 }
diff --git a/examples/src/index.tsx → example/src/index.tsx b/examples/src/index.tsx → example/src/index.tsx
diff --git a/examples/tsconfig.json → example/tsconfig.json b/examples/tsconfig.json → example/tsconfig.json
diff --git a/examples/webpack.config.js → example/webpack.config.js b/examples/webpack.config.js → example/webpack.config.js
diff --git a/examples/yarn.lock → example/yarn.lock b/examples/yarn.lock → example/yarn.lock
diff --git a/tsconfig.json b/tsconfig.json
@@ -18,5 +18,5 @@
     "strict": true,
     "target": "ESNext"
   },
-  "exclude": ["node_modules", "dist", "examples"]
+  "exclude": ["node_modules", "dist", "example"]
 }