From 04127ff0cbbb3c67d3d75dc01cd306ddb690ef5b Mon Sep 17 00:00:00 2001
From: Michael Papadopoulos <micpap25@gmail.com>
Date: Tue, 9 Jul 2024 14:03:31 -0400
Subject: [PATCH] [Developer:Documentation] Update README.md for Github
 releasing (#671)

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bbca47c1..6d6e888c 100644
--- 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
+```
+