Skip to content

Commit

Permalink
3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jonschlinkert committed Apr 19, 2021
1 parent 25f9792 commit 4198053
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .verb.md
Original file line number Diff line number Diff line change
@@ -1,8 1,8 @@
## Why is this better for recursively reading directories?
## Why use @folder/readdir and not some other lib?

- It's [blazing fast](#benchmarks).
- It has a simple, [straightforward API](#comparison) and intuitive [options](#options) for advanced use cases.
- Optionally returns an array of [Dirent](https://nodejs.org/api/fs.html#fs_class_fs_dirent) objects. Returns strings by default.
- Optionally returns an array of file objects (extends node.js native [fs.Dirent](https://nodejs.org/api/fs.html#fs_class_fs_dirent)). Returns path strings by default.
- No dependencies

## Benchmarks
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 12,11 @@ Install with [npm](https://www.npmjs.com/) (requires [Node.js](https://nodejs.or
$ npm install --save @folder/readdir
```

## Why is this better for recursively reading directories?
## Why use @folder/readdir and not some other lib?

* It's [blazing fast](#benchmarks).
* It has a simple, [straightforward API](#comparison) and intuitive [options](#options) for advanced use cases.
* Optionally returns an array of [Dirent](https://nodejs.org/api/fs.html#fs_class_fs_dirent) objects. Returns strings by default.
* Optionally returns an array of file objects (extends node.js native [fs.Dirent](https://nodejs.org/api/fs.html#fs_class_fs_dirent)). Returns path strings by default.
* No dependencies

## Benchmarks
Expand Down
31 changes: 27 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
{
"name": "@folder/readdir",
"version": "2.1.0",
"version": "3.0.0",
"description": "Recursively read a directory, blazing fast.",
"repository": "folder/readdir",
"homepage": "https://github.com/folder/readdir",
Expand Down Expand Up @@ -33,27 33,50 @@
"absolute",
"async",
"await",
"commonjs",
"crawl",
"crawler",
"deep",
"dir",
"directories",
"directory",
"dirent",
"dirname",
"dirs",
"file",
"es6",
"fast",
"fdir",
"file system",
"file",
"files",
"filesystem",
"filter",
"find",
"folder",
"folders",
"fs",
"io",
"list",
"listing",
"ls",
"nested",
"os",
"promise",
"read",
"readdir",
"readdirp",
"readdirrecursive",
"recurse",
"recursive"
"recursive",
"scandir",
"speed",
"stream",
"streams",
"sys",
"tree",
"util",
"walk",
"walker"
],
"verb": {
"toc": false,
Expand All @@ -76,4 99,4 @@
"reflinks": true
}
}
}
}

0 comments on commit 4198053

Please sign in to comment.