X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=org.simantics.maps.server%2Fnode%2Fnode-v4.8.0-win-x64%2Fnode_modules%2Fnpm%2Fnode_modules%2Finit-package-json%2FREADME.md;fp=org.simantics.maps.server%2Fnode%2Fnode-v4.8.0-win-x64%2Fnode_modules%2Fnpm%2Fnode_modules%2Finit-package-json%2FREADME.md;h=bd64c1230986fcf99f28ad3d4b31432b31fcd0a6;hb=2529be6d456deeb07c128603ce4971f1dc29b695;hp=0000000000000000000000000000000000000000;hpb=2636fc31c16c23711cf2b06a4ae8537bba9c1d35;p=simantics%2Fdistrict.git diff --git a/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/node_modules/init-package-json/README.md b/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/node_modules/init-package-json/README.md new file mode 100644 index 00000000..bd64c123 --- /dev/null +++ b/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/node_modules/init-package-json/README.md @@ -0,0 +1,45 @@ +# init-package-json + +A node module to get your node module started. + +[![Build Status](https://secure.travis-ci.org/npm/init-package-json.svg)](http://travis-ci.org/npm/init-package-json) + +## Usage + +```javascript +var init = require('init-package-json') +var path = require('path') + +// a path to a promzard module. In the event that this file is +// not found, one will be provided for you. +var initFile = path.resolve(process.env.HOME, '.npm-init') + +// the dir where we're doin stuff. +var dir = process.cwd() + +// extra stuff that gets put into the PromZard module's context. +// In npm, this is the resolved config object. Exposed as 'config' +// Optional. +var configData = { some: 'extra stuff' } + +// Any existing stuff from the package.json file is also exposed in the +// PromZard module as the `package` object. There will also be free +// vars for: +// * `filename` path to the package.json file +// * `basename` the tip of the package dir +// * `dirname` the parent of the package dir + +init(dir, initFile, configData, function (er, data) { + // the data's already been written to {dir}/package.json + // now you can do stuff with it +}) +``` + +Or from the command line: + +``` +$ npm-init +``` + +See [PromZard](https://github.com/npm/promzard) for details about +what can go in the config file.