add berief docs

unjs · Sep 6, 2022 · 577c91f · 577c91f
1 parent f4ff59c
commit 577c91f
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -97,6 +97,15 @@ const filename = await resolveFile('README.md', {
 })
 ```
 
+### `resolveLockFile`
+
+Find path to the lock file (`yarn.lock`, `package-lock.json`, `pnpm-lock.yaml`, `npm-shrinkwrap.json`) or throws an error.
+
+```js
+import { resolveLockFile } from 'pkg-types'
+const lockfile = await resolveFile('.')
+```
+
 ## Types
 
 **Note:** In order to make types working, you need to install `typescript` as a devDependency.