Skip to content

Commit 266f1c9

Browse files
committed
Update the README with more helpful info.
1 parent 1daed65 commit 266f1c9

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,26 @@ This is just enough info to get you up and running.
44

55
More info available via `man npm`.
66

7+
## IMPORTANT
8+
9+
You need node v0.2.0 or higher to run this program.
10+
11+
You shouldn't use sudo with it.
12+
713
## Simple Install
814

915
To install npm, do this:
1016

1117
curl http://npmjs.org/install.sh | sh
1218

1319
If it dies with a "Permission Denied" or EACCESS error, then that probably
14-
means that you are running node in a shared root-owned location. In that
15-
case, you'll have to use sudo.
20+
means that you are running node in a shared root-owned location. You've
21+
got options.
1622

17-
curl http://npmjs.org/install.sh | sudo sh
23+
Using sudo with npm is Very Not Recommended. Either chown the folder that
24+
is your node install prefix, or set up a `.npmrc` file pointing `root`,
25+
`binroot`, and `manroot` to folders that you own. (The .npmrc is just an
26+
ini-formatted file, so you can use any editor to do this.)
1827

1928
## More Fancy Installing
2029

@@ -35,7 +44,9 @@ on it, you can do this:
3544

3645
If you check out the Makefile, you'll see that these are just running npm commands
3746
at the cli.js script directly. You can also use npm without ever installing
38-
it by using `./cli.js` instead of "npm".
47+
it by using `node cli.js` instead of "npm". Set up an alias if you want, that's
48+
fine. (You'll still need read permission to the root/binroot/manroot folders,
49+
but at this point, you probably grok all that anyway.)
3950

4051
## Uninstalling
4152

@@ -47,6 +58,14 @@ Or, if that fails,
4758

4859
make uninstall
4960

61+
## Install Problems
62+
63+
There's was an issue prior to npm version 0.2.0 where packages whose names contained
64+
hyphen characters would be odd.
65+
66+
If you've installed any packages with `-` in the name prior to 0.2.0, then you ought
67+
to remove and reinstall them.
68+
5069
## More Docs
5170

5271
Check out the [docs](http://github.com/isaacs/npm/blob/master/doc/).

0 commit comments

Comments
 (0)