summaryrefslogtreecommitdiff
path: root/node_modules/tinyglobby/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/tinyglobby/README.md')
-rw-r--r--node_modules/tinyglobby/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/node_modules/tinyglobby/README.md b/node_modules/tinyglobby/README.md
new file mode 100644
index 0000000..15695e6
--- /dev/null
+++ b/node_modules/tinyglobby/README.md
@@ -0,0 +1,25 @@
+# tinyglobby
+
+[![npm version](https://img.shields.io/npm/v/tinyglobby.svg?maxAge=3600)](https://npmjs.com/package/tinyglobby)
+[![monthly downloads](https://img.shields.io/npm/dm/tinyglobby.svg?maxAge=3600)](https://npmjs.com/package/tinyglobby)
+
+A fast and minimal alternative to globby and fast-glob, meant to behave the same way.
+
+Both globby and fast-glob present some behavior no other globbing lib has,
+which makes it hard to manually replace with something smaller and better.
+
+This library uses only two subdependencies, compared to `globby`'s [23](https://npmgraph.js.org/?q=globby@14.1.0)
+and `fast-glob`'s [17](https://npmgraph.js.org/?q=fast-glob@3.3.3).
+
+## Usage
+
+```js
+import { glob, globSync } from 'tinyglobby';
+
+await glob(['files/*.ts', '!**/*.d.ts'], { cwd: 'src' });
+globSync('src/**/*.ts', { ignore: '**/*.d.ts' });
+```
+
+## Documentation
+
+Visit https://superchupu.dev/tinyglobby to read the full documentation.