Permalink
Browse files

Updated README

  • Loading branch information...
1 parent e1dcf50 commit 6a0a96ebee7755581a2705c33dd946aca8e133f7 @davglass davglass committed with isaacs Feb 14, 2014
Showing with 11 additions and 2 deletions.
  1. +11 −2 README.md
View
13 README.md
@@ -5,12 +5,21 @@ structure with all the data.
npm uses this.
+## 1.0.0
+
+Breaking changes in `1.0.0`:
+
+The second argument is now an `Object` that contains the following keys:
+
+ * `depth` optional, defaults to Infinity
+ * `log` optional log Function
+ * `dev` optional, dev=true to mark devDeps as extraneous
+
## Usage
```javascript
var readInstalled = require("read-installed")
-// depth is optional, defaults to Infinity
-readInstalled(folder, depth, logFunction, function (er, data) {
+readInstalled(folder, { depth, log, dev }, function (er, data) {
...
})
```

0 comments on commit 6a0a96e

Please sign in to comment.