diff options
Diffstat (limited to 'deps/npm/doc/cli/developers.md')
| -rw-r--r-- | deps/npm/doc/cli/developers.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/deps/npm/doc/cli/developers.md b/deps/npm/doc/cli/developers.md index 9123f35a3..7ab905bfa 100644 --- a/deps/npm/doc/cli/developers.md +++ b/deps/npm/doc/cli/developers.md @@ -27,12 +27,23 @@ A package is: * d) a `<name>@<version>` that is published on the registry with (c) * e) a `<name>@<tag>` that points to (d) * f) a `<name>` that has a "latest" tag satisfying (e) +* g) a `git` url that, when cloned, results in (a). Even if you never publish your package, you can still get a lot of benefits of using npm if you just want to write a node program (a), and perhaps if you also want to be able to easily install it elsewhere after packing it up into a tarball (b). +Git urls can be of the form: + + git://github.com/user/project.git#commit-ish + git+ssh://user@hostname:project.git#commit-ish + git+http://user@hostname/project/blah.git#commit-ish + git+https://user@hostname/project/blah.git#commit-ish + +The `commit-ish` can be any tag, sha, or branch which can be supplied as +an argument to `git checkout`. The default is `master`. + ## The package.json File You need to have a `package.json` file in the root of your project to do |