From b19ced5ccd762191a0b58b281315fd4742b10fd6 Mon Sep 17 00:00:00 2001
From: wolfy1339 <webmaster@wolfy1339.com>
Date: Tue, 16 Apr 2024 14:19:09 -0400
Subject: [PATCH] docs: add notes on required typescript changes

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index e0075945..037b99d1 100644
--- a/README.md
+++ b/README.md
@@ -76,6 +76,12 @@ import { createAppAuth } from "@octokit/auth-app";
 </tbody>
 </table>
 
+> [!IMPORTANT]
+> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`.
+>
+> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
+> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
+
 ### Authenticate as GitHub App (JSON Web Token)
 
 ```js