diff options
Diffstat (limited to 'deps/npm/html/doc/README.html')
| -rw-r--r-- | deps/npm/html/doc/README.html | 74 |
1 files changed, 9 insertions, 65 deletions
diff --git a/deps/npm/html/doc/README.html b/deps/npm/html/doc/README.html index 7d191393d4..6160d3b09d 100644 --- a/deps/npm/html/doc/README.html +++ b/deps/npm/html/doc/README.html @@ -18,6 +18,14 @@ <p><strong>You need node v0.8 or higher to run this program.</strong></p> <p>To install an old <strong>and unsupported</strong> version of npm that works on node 0.3 and prior, clone the git repo and dig through the old tags and branches.</p> +<p><strong>npm is configured to use npm, Inc.'s public package registry at +<a href="https://registry.npmjs.org">https://registry.npmjs.org</a> by default.</strong></p> +<p>You can configure npm to use any compatible registry you +like, and even run your own registry. Check out the <a href="https://docs.npmjs.com/misc/registry">doc on +registries</a>.</p> +<p>Use of someone else's registry may be governed by terms of use. The +terms of use for the default public registry are available at +<a href="https://www.npmjs.com">https://www.npmjs.com</a>.</p> <h2 id="super-easy-install">Super Easy Install</h2> <p>npm is bundled with <a href="http://nodejs.org/download/">node</a>.</p> <h3 id="windows-computers">Windows Computers</h3> @@ -84,76 +92,12 @@ npm config get globalconfig # defaults to /usr/local/etc/npmrc must remove them yourself manually if you want them gone. Note that this means that future npm installs will not remember the settings that you have chosen.</p> -<h2 id="using-npm-programmatically">Using npm Programmatically</h2> -<p>Although npm can be used programmatically, its API is meant for use by the CLI -<em>only</em>, and no guarantees are made regarding its fitness for any other purpose. -If you want to use npm to reliably perform some task, the safest thing to do is -to invoke the desired <code>npm</code> command with appropriate arguments.</p> -<p>The semantic version of npm refers to the CLI itself, rather than the -underlying API. <em>The internal API is not guaranteed to remain stable even when -npm's version indicates no breaking changes have been made according to -semver.</em></p> -<p>If you <em>still</em> would like to use npm programmatically, it's <em>possible</em>. The API -isn't very well documented, but it <em>is</em> rather simple.</p> -<p>Eventually, npm will be just a thin CLI wrapper around the modules that it -depends on, but for now, there are some things that only the CLI can do. You -should try using one of npm's dependencies first, and only use the API if what -you're trying to do is only supported by npm itself.</p> -<pre><code class="lang-javascript">var npm = require("npm") -npm.load(myConfigObject, function (er) { - if (er) return handlError(er) - npm.commands.install(["some", "args"], function (er, data) { - if (er) return commandFailed(er) - // command succeeded, and data might have some info - }) - npm.registry.log.on("log", function (message) { .... }) -}) -</code></pre> -<p>The <code>load</code> function takes an object hash of the command-line configs. -The various <code>npm.commands.<cmd></code> functions take an <strong>array</strong> of -positional argument <strong>strings</strong>. The last argument to any -<code>npm.commands.<cmd></code> function is a callback. Some commands take other -optional arguments. Read the source.</p> -<p>You cannot set configs individually for any single npm function at this -time. Since <code>npm</code> is a singleton, any call to <code>npm.config.set</code> will -change the value for <em>all</em> npm commands in that process.</p> -<p>See <code>./bin/npm-cli.js</code> for an example of pulling config values off of the -command line arguments using nopt. You may also want to check out <code>npm -help config</code> to learn about all the options you can set there.</p> <h2 id="more-docs">More Docs</h2> <p>Check out the <a href="https://docs.npmjs.com/">docs</a>, especially the <a href="https://docs.npmjs.com/misc/faq">faq</a>.</p> <p>You can use the <code>npm help</code> command to read any of them.</p> <p>If you're a developer, and you want to use npm to publish your program, you should <a href="https://docs.npmjs.com/misc/developers">read this</a></p> -<h2 id="legal-stuff">Legal Stuff</h2> -<p>"npm" and "The npm Registry" are owned by npm, Inc. -All rights reserved. See the included LICENSE file for more details.</p> -<p>"Node.js" and "node" are trademarks owned by Joyent, Inc.</p> -<p>Modules published on the npm registry are not officially endorsed by -npm, Inc. or the Node.js project.</p> -<p>Data published to the npm registry is not part of npm itself, and is -the sole property of the publisher. While every effort is made to -ensure accountability, there is absolutely no guarantee, warranty, or -assertion expressed or implied as to the quality, fitness for a -specific purpose, or lack of malice in any given npm package.</p> -<p>If you have a complaint about a package in the public npm registry, -and cannot <a href="https://docs.npmjs.com/misc/disputes">resolve it with the package -owner</a>, please email -<a href="mailto:support@npmjs.com">support@npmjs.com</a> and explain the situation.</p> -<p>Any data published to The npm Registry (including user account -information) may be removed or modified at the sole discretion of the -npm server administrators.</p> -<h3 id="in-plainer-english">In plainer English</h3> -<p>npm is the property of npm, Inc.</p> -<p>If you publish something, it's yours, and you are solely accountable -for it.</p> -<p>If other people publish something, it's theirs.</p> -<p>Users can publish Bad Stuff. It will be removed promptly if reported. -But there is no vetting process for published modules, and you use -them at your own risk. Please inspect the source.</p> -<p>If you publish Bad Stuff, we may delete it from the registry, or even -ban your account in extreme cases. So don't do that.</p> <h2 id="bugs">BUGS</h2> <p>When you find issues, please report them:</p> <ul> @@ -183,5 +127,5 @@ will no doubt tell you to put the output in a gist or email.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer"><a href="../doc/README.html">README</a> — npm@3.3.12</p> +<p id="footer"><a href="../doc/README.html">README</a> — npm@3.6.0</p> |