Skip to content

Commit c675547

Browse files
committed
Update README.md
1 parent d5b3d2c commit c675547

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ const caseCorrectPath = trueCasePathSync(<fileSystemPath>)
1919

2020
> **NOTE**: If no matching path exists, an error with be thrown.
2121
22+
---
23+
2224
Optionally takes a second argument to use as the base path to begin case-correction from. This can be particularly useful within shared hosting environments since true-case-path relies on the ability to list a directory's contents in order to check the case and attempting to list the contents of `/` or `/home` will generally result in a permissions error.
2325

2426
```typescript

0 commit comments

Comments
 (0)