nodereport project packaging updates #13
Conversation
1. Add platform and node version support statement 2. Update usage - now installable from npmjs 3. Separate example install command line from example code 4. Add REPL example 5. Highlight setEvents() API 6. Demo applications are now in github, not npm
1. nodereport module is copied to top level directory as part of build, so 'main' property should reference that 2. Direct homepage property URL to start of README text 3. Add contributors 4. Add bugs property, referencing nodereport github URL
| @@ -0,0 +1,15 @@ | |||
| # Instructions for maintainers of the nodereport project | |||
|
|
|||
| ## Releasing to www.npmjs.com | |||
There was a problem hiding this comment.
Can you replace the references to www.npmjs.com with just npm.
There was a problem hiding this comment.
Are you sure? (some) People are already confused aboutthe difference between npm the cli, and npmjs.org the package repository... but above should be npmjs.org, IMO, not the company URL.
There was a problem hiding this comment.
I thought most people referred to just "publish on npm." I've never really seen a website referenced. I guess technically it's being published to the npm registry.
There was a problem hiding this comment.
Fair enough, "publish to npm" is clear enough. Anybody with the rights to publish nodereport should know what they are publishing to.
There was a problem hiding this comment.
I just took the URL from my browser, npmjs.org re-directs immediately to npmjs.com.
OK, I will change to 'publish to npm', people know what that means.
| @@ -0,0 +1,15 @@ | |||
| # Instructions for maintainers of the nodereport project | |||
|
|
|||
| ## Publishing to the NPM registry | |||
There was a problem hiding this comment.
So, according to this post, I think npm should always be lowercase (see item 13).
| exception.js - NodeReport triggered by unhandled exception | ||
| fatalerror.js - NodeReport triggered by fatal error on Javascript heap out of memory | ||
| loop.js - looping application, NodeReport triggered using kill -USR2 <pid> | ||
| 1. api.js - NodeReport triggered by Javascript API call |
There was a problem hiding this comment.
Javascript -> JavaScript here and elsewhere.
|
Maybe update |
|
Personally, I'd put a generic email address in package.json, and delete AUTHORS, its painful to maintain 2 copies of what is already available in git metadata. If not, at least script the generation of AUTHORs: https://github.com/sam-github/git-extras/blob/master/bin/git-authors |
|
Looks like AUTHORS is a github thing, whereas the package.json property came originally from 'npm init'. Other nodejs projects vary, eg https://github.com/nodejs/llnode has both, and they are not consistent. OK, lets follow the https://github.com/nodejs/nan example, and just have the contributors array in package.json, deleting AUTHORS. |
Contributors are listed in package.json. This change saves having them listed in two places, and is consistent with other nodejs projects such as nan and node-gyp.
|
ping @richardlau @sam-github @cjihrig are you OK with this PR now? thanks |
|
LGTM |
Improvements and corrections to nodereport README, additional metadata in package.json and new MAINTAINER file to document NPM release procedure. See commits for details.