From 4198053d3cd27c71f64f6f3793c5fdc938af46bc Mon Sep 17 00:00:00 2001 From: Jon Schlinkert Date: Mon, 19 Apr 2021 04:14:40 -0400 Subject: [PATCH] 3.0.0 --- .verb.md | 4 ++-- README.md | 4 ++-- package.json | 31 +++++++++++++++++++++++++++---- 3 files changed, 31 insertions(+), 8 deletions(-) diff --git a/.verb.md b/.verb.md index cef7da8..c4a7cb6 100644 --- a/.verb.md +++ b/.verb.md @@ -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 diff --git a/README.md b/README.md index aec28a3..adad404 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index 0f07329..51ee8e0 100644 --- a/package.json +++ b/package.json @@ -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", @@ -33,14 +33,21 @@ "absolute", "async", "await", + "commonjs", + "crawl", + "crawler", "deep", "dir", "directories", "directory", + "dirent", "dirname", "dirs", - "file", + "es6", + "fast", + "fdir", "file system", + "file", "files", "filesystem", "filter", @@ -48,12 +55,28 @@ "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, @@ -76,4 +99,4 @@ "reflinks": true } } -} +} \ No newline at end of file