README.md

   1 # fstream-npm
   2
   3 This is an fstream DirReader class that will read a directory and filter
   4 things according to the semantics of what goes in an npm package.
   5
   6 For example:
   7
   8 ```javascript
   9 // This will print out all the files that would be included
  10 // by 'npm publish' or 'npm install' of this directory.
  11
  12 var FN = require("fstream-npm")
  13 FN({ path: "./" })
  14   .on("child", function (e) {
  15     console.error(e.path.substr(e.root.path.length + 1))
  16   })
  17 ```
  18