Skip to content

Commit cabb063

Browse files
committed
docs: clarify description of unixNp function in README
1 parent 4972a18 commit cabb063

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

.changeset/wicked-taxes-cry.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@knide/pathnorm": patch
3+
---
4+
5+
docs: clarify description of `unixNp` function in README

package/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ pnpm add @knide/pathnorm
2525

2626
| Import | Win32 | UNC | Namespace | URLs | POSIX |
2727
|-------------------------|-------|-----|-----------|------|-------|
28-
| `@knide/pathnorm` | || | | |
29-
| `@knide/pathnorm/posix` | || | | |
28+
| `@knide/pathnorm` | || | | |
29+
| `@knide/pathnorm/posix` | || | | |
3030

3131
Use `@knide/pathnorm/posix` in browser or web server contexts where Win32 paths will never appear — it's lighter and purpose-built for URLs and POSIX paths.
3232

@@ -80,7 +80,7 @@ np("C:\\projects//my-app\\\\src")
8080

8181
### `unixNp(...parts)` (always forward slashes)
8282

83-
Like `np`, but always returns forward slashes. Useful when working with Win32 paths in a Unix-expecting context.
83+
Like `np`, but always returns a Unix-style path with forward slashes. Useful when working with Win32 paths in a Unix-expecting context.
8484

8585
```ts
8686
import { unixNp } from '@knide/pathnorm'

0 commit comments

Comments
 (0)