docs: update documentation

Author: BobbieGoede

README.md

@@ -14,17 +14,25 @@ A collection of utility functions for Nuxt module authors.
 npm i nuxt-module-utils
 ```
 
-<!-- ## Usage
+## Usage
+
+### `hoistDependencies(hoist: string[])`
+
+While Nuxt provides the `typescript.hoist` option to generate aliases for nested dependencies within pnpm monorepos, it is processed before modules are set up.
+
+The `hoistDependencies` utility allows you to hoist dependencies from within your module's `setup` function. It works by resolving the paths of the specified packages and adding them to Nuxt's TypeScript configuration, ensuring they are included in the generated `tsconfig.json`.
 
 ```ts
 // src/module.ts
-import { someUtil } from 'nuxt-module-utils'
+import { defineNuxtModule } from '@nuxt/kit'
+import { hoistDependencies } from 'nuxt-module-utils'
 
 export default defineNuxtModule({
-  setup() {
+  async setup() {
+    await hoistDependencies(['my-lib', 'my-other-lib'])
   }
 })
-``` -->
+```
 
 ## Sponsors
 

src/hoist.ts

@@ -7,8 +7,7 @@ import { version } from "nuxt/package.json";
 const isVersion4 = version.startsWith("4");
 
 /**
- * Adapted from Nuxt source code
- * https://github.com/nuxt/nuxt/blob/a0f9ddfe241bcf555f6305aa10c087a1fe64af87/packages/nuxt/src/core/utils/types.ts#L6
+ * @see [Nuxt source](https://github.com/nuxt/nuxt/blob/a0f9ddfe241bcf555f6305aa10c087a1fe64af87/packages/nuxt/src/core/utils/types.ts#L6)
  */
 async function resolveTypePath(path: string, subpath: string, searchPaths = tryUseNuxt()?.options.modulesDir) {
   try {
@@ -28,8 +27,15 @@ async function resolveTypePath(path: string, subpath: string, searchPaths = tryU
 }
 
 /**
- * Adapted from Nuxt source code
- * https://github.com/nuxt/nuxt/blob/5146bed75eb1a6617e2fb17ea97b3d121cd94930/packages/nuxt/src/core/nuxt.ts
+ * Hoist dependencies for TypeScript path mapping.
+ *
+ * This function is a workaround for module authors who need to hoist dependencies
+ * for TypeScript path mapping, it mimics the behavior of `nuxt.options.typescript.hoist`
+ *
+ * @param hoist - An array of package names to hoist.
+ * @param nuxt - The Nuxt instance.
+ *
+ * @see [Nuxt source](https://github.com/nuxt/nuxt/blob/5146bed75eb1a6617e2fb17ea97b3d121cd94930/packages/nuxt/src/core/nuxt.ts#L188-L290)
  */
 export async function hoistDependencies(hoist: string[], nuxt = useNuxt()) {
   const packageJSON = await readPackageJSON(nuxt.options.rootDir).catch(() => ({} as PackageJson));