Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the installation instructions in the README.md to use npm package installation instead of downloading release artifacts, and adds a comprehensive .npmignore file to prepare the project for npm publishing.
- Replaced manual release artifact download with standard
npm installcommand - Added package.json script example for easier server startup
- Created comprehensive .npmignore file to exclude development files from npm package
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| README.md | Updated installation instructions to use npm install instead of manual zip download |
| .npmignore | Added comprehensive ignore file to exclude development files, tests, and build artifacts from npm package |
| @@ -0,0 +1,83 @@ | |||
| # Test coverage reports | |||
| coverage/ | |||
There was a problem hiding this comment.
The coverage/ directory is listed twice (lines 2 and 29). Remove the duplicate entry to keep the file clean.
.npmignore
Outdated
| *.pid.lock | ||
|
|
||
| # Coverage directories | ||
| coverage/ |
There was a problem hiding this comment.
The coverage/ directory is listed twice (lines 2 and 29). Remove the duplicate entry to keep the file clean.
| coverage/ |
| .nyc_output/ | ||
|
|
||
| # Test runner cache | ||
| .cache/ |
There was a problem hiding this comment.
The .cache/ directory is listed twice (lines 6 and 60). Remove the duplicate entry to avoid redundancy.
.npmignore
Outdated
|
|
||
| # Misc | ||
| *.tgz | ||
| .cache/ |
There was a problem hiding this comment.
The .cache/ directory is listed twice (lines 6 and 60). Remove the duplicate entry to avoid redundancy.
| .cache/ |
| @@ -0,0 +1,83 @@ | |||
| # Test coverage reports | |||
| coverage/ | |||
| .nyc_output/ | |||
There was a problem hiding this comment.
The .nyc_output/ directory is listed twice (lines 3 and 31). Remove the duplicate entry to maintain a clean ignore file.
.npmignore
Outdated
| # Coverage directories | ||
| coverage/ | ||
| *.lcov | ||
| .nyc_output/ |
There was a problem hiding this comment.
The .nyc_output/ directory is listed twice (lines 3 and 31). Remove the duplicate entry to maintain a clean ignore file.
1 participant
Fixed README.md, updated install.