Skip to content

Commit 154a28f

Browse files
committed
docs: when should i use this?
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent bf12c38 commit 154a28f

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.dictionary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ micnncim
2222
nocheck
2323
npmrc
2424
nvmrc
25+
pcre
2526
pkgs
2627
pnpm
2728
preid

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@ factory function to create file extension expressions.
2929

3030
## When should I use this?
3131

32-
**TODO**: use cases.
32+
Regular expressions exported from this package can be used to test both file extensions and names. A factory function is
33+
also exported that can be used to create a regular expression for any given file extension.
34+
35+
**Note**:
36+
37+
- Expressions are ECMAScript-compatible. They have not been tested with other flavors (PCRE, PCRE2, etc)
3338

3439
## Install
3540

0 commit comments

Comments
 (0)