Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2010-12-06 09:11:43 +0300
committerisaacs <i@izs.me>2010-12-06 09:11:43 +0300
commite182b348d7422f704d080d7a71645cae0412771a (patch)
tree754ba05fe6314412f40dd3fedfdb444a43f1c87f /doc/developers.md
parent866196f028dba1b33374cbb46f20e85b2d9d988a (diff)
update this document
Diffstat (limited to 'doc/developers.md')
-rw-r--r--doc/developers.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/doc/developers.md b/doc/developers.md
index 2b3267ff5..215c33dc2 100644
--- a/doc/developers.md
+++ b/doc/developers.md
@@ -57,23 +57,28 @@ least, you need:
program (like what the "foo" package gives you at require("foo")),
then you need to specify that in the "main" field.
+* directories:
+ This is a hash of folders. The best ones to include are "lib" and
+ "doc", but if you specify a folder full of man pages in "man", then
+ they'll get installed just like these ones.
+
## Make Sure Your Package Installs and Works
**This is important.**
-If you can not install it locally, you'll have
+If you can not install it locally, you'll have
problems trying to publish it. Or, worse yet, you'll be able to
publish it, but you'll be publishing a broken or pointless package.
So don't do that.
In the root of your package, do this:
- npm install .
+ npm install
That'll show you that it's working. If you'd rather just create a symlink
package that points to your working directory, then do this:
- npm link .
+ npm link
Use `npm ls installed` to see if it's there.
@@ -110,22 +115,15 @@ details:
## Publish your package
-This part's easy.
+This part's easy. IN the root of your folder, do this:
- npm publish /path/to/my-package
+ npm publish
You can give publish a url to a tarball, or a filename of a tarball,
or a path to a folder.
-If you're in the root of your folder, then you can just do:
-
- npm publish
-
-since the default argument is ".".
-
## Brag about it
Send emails, write blogs, blab in IRC.
Tell the world how easy it is to install your program!
-