Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
micpap25 authored Jul 1, 2024
1 parent 06cfcfc commit 1f1a342
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -73,3 +73,15 @@ $ npm test
# lint the code
$ npm run lint
```

## Building
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
```

0 comments on commit 1f1a342

Please sign in to comment.