Browse files

better doc

  • Loading branch information...
1 parent 14e99bf commit 60f254d1ff34561f9d3c90310040f9883837afb7 @jeromeetienne committed Feb 28, 2011
Showing with 18 additions and 1 deletion.
  1. +1 −1 README.md
  2. +11 −0 TODO.md
  3. +6 −0 nmod
View
2 README.md
@@ -1,7 +1,7 @@
# nmod
nmod is a [node_modules](http://nodejs.org/docs/v0.4.1/api/modules.html#loading_from_node_modules_Folders)
-packages installer.
+manager.
node_modules is a [0.4 new feature](https://github.com/joyent/node/blob/v0.4.0/ChangeLog#L5).
It provides a simple and regular way to install packages (read
View
11 TODO.md
@@ -1,5 +1,14 @@
### BUGS
+* complete npm install url
+ * support tar+zip
+ * support git too ?
+ * support any url but be better when you can (e.g. github url)
+* can i do a specific github
+ * like using github api instead of npmjs one
+ * to fix the version flexibility of fixed tar
+ * something like "tags" == all available versions
+
* nmod install notexistingpkg do a crash...
* allow a search
* curl "http://search.npmjs.org/_view/search?startkey=%22express%22&endkey=%22expressZZZZZZZZZZZZZZZZZZZ%22&reduce=false"
@@ -15,6 +24,8 @@
* nmod install https://github.com/isaacs/npm/tarball/v0.3.9
* read and follow
* http://networkimprov.github.com/node-doc-api/all.html#addenda_Package_Manager_Tips
+* better report for nmod list ?
+ * currently this is like a ls -R
* better feedback to the user
* download progress
* error message
View
6 nmod
@@ -487,6 +487,12 @@ var nmod = function(cmdline, cmdopts){
})
}
+ /**
+ * @param {String} pkgUrl the url of the package to fetch
+ * @param {String} pkgName the name of the package (display only ?)
+ * @param {String} pkgVers the version of the package
+ * @param {Object} pkgJson an potentially better package.json (e.g. from npmjs.org)
+ */
var installFromPkgUrl = function(pkgUrl, pkgName, pkgVers, pkgJson){
utils.fetchUrl(pkgUrl, function(tarData){
var modDirname = ROOTDIR+"/node_modules"

0 comments on commit 60f254d

Please sign in to comment.