From 236e11fbbdfae661fc91167cf270d50fcb5e725c Mon Sep 17 00:00:00 2001 From: Naomi Date: Tue, 25 Jun 2024 18:24:39 -0700 Subject: [PATCH] docs: update instructions for rootDir and outDir --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4bd29eb..5cb8502 100644 --- a/README.md +++ b/README.md @@ -22,24 +22,18 @@ This package is compatible with TypeScript 5. To use this package, add the following to your `tsconfig.json` file: -```json -{ - "extends": "@nhcarrigan/typescript-config" -} -``` - -By default, the root directory is `src` and the output directory is `prod`. To override these: - ```json { "extends": "@nhcarrigan/typescript-config", "compilerOptions": { - "rootDir": "code", - "outDir": "dist" + "rootDir": "./src", + "outDir": "./prod" } } ``` +You may set `rootDir` and `outDir` to any directory in your project you'd like. As of V4.0.0 this package no longer sets them by default due to incompatibilities with some package managers. + ## Feedback and Bugs If you have feedback or a bug report, please feel free to open a GitHub issue!