Merge branch 'bump_webpack' of github.com:thepiyush-303/pdf-annotate.…

…js into bump_webpack
Submitty · Jul 12, 2024 · 6a4857f · 6a4857f
2 parents dfe5fbc + 2313051
commit 6a4857f
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ To report issues for pdf-annotate.js, please file them under the [Submitty/Submi
 ## Installation
 
 ```bash
-npm install @submitty/pdf-annotate.js
+npm install Submitty/pdf-annotate.js
 ```
 
 ## Example
@@ -73,3 +73,15 @@ $ npm test
 # lint the code
 $ npm run lint
 ```
+
+## Building
+**Do not** commit your built files when contributing.
+If on Windows, change the `build` script in `package.json` to `webpack && SET MINIFY=1&webpack`.
+```bash
+# switch to node v14 or earlier
+$ nvm use 14
+
+# build the dist files
+$ npm run build
+```
+
diff --git a/dist/pdf-annotate.js b/dist/pdf-annotate.js
diff --git a/dist/pdf-annotate.js.map b/dist/pdf-annotate.js.map
diff --git a/dist/pdf-annotate.min.js b/dist/pdf-annotate.min.js
diff --git a/dist/pdf-annotate.min.js.map b/dist/pdf-annotate.min.js.map