Skip to content
Browse files

first

  • Loading branch information...
0 parents commit 147816de5245a00e2694599e39f62585aa33b38b @isaacs isaacs committed
Showing with 18 additions and 0 deletions.
  1. +18 −0 README.md
18 README.md
@@ -0,0 +1,18 @@
+# fstream-npm
+
+This is an fstream DirReader class that will read a directory and filter
+things according to the semantics of what goes in an npm package.
+
+For example:
+
+```javascript
+// This will print out all the files that would be included
+// by 'npm publish' or 'npm install' of this directory.
+
+var FN = require("fstream-npm")
+FN({ path: "./" })
+ .on("child", function (e) {
+ console.error(e.path.substr(e.root.path.length + 1))
+ })
+```
+

0 comments on commit 147816d

Please sign in to comment.
Something went wrong with that request. Please try again.