Skip to content

[Developer:Documentation] Update README.md for Github releasing #671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 9, 2024
Merged

[Developer:Documentation] Update README.md for Github releasing #671

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f1a342
Update README.md
micpap25 Jul 1, 2024
cf6de70
Update README.md
micpap25 Jul 2, 2024
424e0d5
Merge branch 'main' into micpap25-patch-1
micpap25 Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
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
Copy link

@unrevised6419 unrevised6419 Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Does this mean that pdf-annotate won't be published anymore on NPM? If yes, where can I read more about this decision?! 👀

```

## Example
Expand Down Expand Up @@ -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
```