docs: improve ts-plugin installation and usage instructions (#14)

Some parts are from: https://github.com/nonara/ts-patch?tab=readme-ov-file#usage

Author: maxmorozoff

README.md

@@ -163,14 +163,16 @@ _(See more advanced `tryCatch` usage examples and API reference further down.)_
 ## Installation
 
 ```bash
+# 1. Install the utility (prod dependency):
+npm i @maxmorozoff/try-catch-tuple 
+
+# 2. Install ts plugin (dev dependencies):
+
 # If using the build transformer, ts-patch is also required
-npm i -D @maxmorozoff/try-catch-tuple @maxmorozoff/try-catch-tuple-ts-plugin ts-patch typescript
+npm i -D @maxmorozoff/try-catch-tuple-ts-plugin ts-patch typescript
 
 # Or for utility + LSP only:
-npm i -D @maxmorozoff/try-catch-tuple @maxmorozoff/try-catch-tuple-ts-plugin typescript
-
-# Or for utility only:
-npm i -D @maxmorozoff/try-catch-tuple typescript
+npm i -D @maxmorozoff/try-catch-tuple-ts-plugin typescript
 ```
 
 ## Configuration (`tsconfig.json`)
@@ -222,16 +224,47 @@ Configure the tooling under `compilerOptions.plugins`.
 
 ## Usage
 
-**1. IDE (Language Service Plugin):**
+### 1. IDE (Language Service Plugin)
 
+- **Select Workspace TypeScript Version:** Ensure your editor is using the workspace's TypeScript version instead of the built-in one (e.g., VS Code: `TypeScript: Select TypeScript Version`).
 - **Restart TS Server:** After configuring the plugin, **restart the TypeScript Server** (e.g., VS Code: `TypeScript: Restart TS server`).
 - Errors will be underlined, and Quick Fixes will be available.
 
-**2. Build (Transformer):**
+### 2. Build (Transformer)
+
+#### Method 1: Live Compiler
+
+The live compiler patches on-the-fly, each time it is run.
+
+**Via commandline:** Simply use `tspc` (instead of `tsc`)
+
+**With tools such as ts-node, webpack, ts-jest, etc:** specify the compiler as  `ts-patch/compiler`
+
+#### Method 2: Persistent Patch
+
+Persistent patch modifies the typescript installation within the `node_modules` path. It requires additional configuration
+to remain persisted, but it carries less load time and complexity compared to the live compiler.
+
+1. Install the patch
+
+```shell
+# For advanced options, see: ts-patch /?
+ts-patch install
+```
+
+2. Add `prepare` script (keeps patch persisted after npm install)
+
+`package.json`
+```jsonc
+{
+  /* ... */
+  "scripts": {
+    "prepare": "ts-patch install -s"
+  }
+}
+```
 
-- **Install `ts-patch`:** `npm i -D ts-patch` (if needed).
-- **Patch TypeScript:** `npx ts-patch install` (run once).
-- **Run Build:** Use `tspc` in your build scripts: `"build": "tspc -p tsconfig.json"`. Errors/warnings appear in `tsc` output.
+For advanced options, see: [ts-patch docs](https://github.com/nonara/ts-patch?tab=readme-ov-file#usage)
 
 ## Configuration Options (Plugin & Transformer)
 

packages/ts-plugin/README.md

@@ -26,11 +26,13 @@ The primary goal is to prevent developers from incorrectly handling the results
 
 ## Installation
 
+Add the following packages to your _development_ dependencies:
+
 ```bash
 # If using the build transformer, ts-patch is also required
 npm i -D @maxmorozoff/try-catch-tuple-ts-plugin ts-patch typescript
 # Or for LSP only:
-# npm i -D @maxmorozoff/try-catch-tuple-ts-plugin typescript
+npm i -D @maxmorozoff/try-catch-tuple-ts-plugin typescript
 ```
 
 ## Configuration (`tsconfig.json`)
@@ -104,32 +106,49 @@ This is the preferred way if using both, as configuration is shared.
 }
 ```
 
-
 ## Usage
 
-**1. IDE (Language Service Plugin):**
+### 1. IDE (Language Service Plugin)
+
+- **Select Workspace TypeScript Version:** Ensure your editor is using the workspace's TypeScript version instead of the built-in one (e.g., VS Code: `TypeScript: Select TypeScript Version`).
+- **Restart TS Server:** After configuring the plugin, **restart the TypeScript Server** (e.g., VS Code: `TypeScript: Restart TS server`).
+- Errors will be underlined, and Quick Fixes will be available.
+
+### 2. Build (Transformer)
+
+#### Method 1: Live Compiler
+
+The live compiler patches on-the-fly, each time it is run.
+
+**Via commandline:** Simply use `tspc` (instead of `tsc`)
 
-- **Restart TS Server:** After adding/changing the plugin configuration in `tsconfig.json`, you **must restart the TypeScript Server** in your editor.
-  - _VS Code:_ Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and run `TypeScript: Restart TS server`.
-- You should now see errors/warnings underlined in your code and have Quick Fixes available.
+**With tools such as ts-node, webpack, ts-jest, etc:** specify the compiler as  `ts-patch/compiler`
 
-**2. Build (Transformer):**
+#### Method 2: Persistent Patch
 
-- **Install `ts-patch`:** (If not already done) `npm i -D ts-patch`
-- **Patch TypeScript:** Run `npx ts-patch install` (or `yarn ts-patch install`) in your project root. This only needs to be done once or after updating TypeScript/ts-patch.
-- **Run Build:** Use `tspc` instead of `tsc` in your build scripts/commands.
+Persistent patch modifies the typescript installation within the `node_modules` path. It requires additional configuration
+to remain persisted, but it carries less load time and complexity compared to the live compiler.
 
-  ```bash
-  # Example command
-  npx tspc -p tsconfig.json
+1. Install the patch
 
-  # Example package.json script
+```shell
+# For advanced options, see: ts-patch /?
+ts-patch install
+```
+
+2. Add `prepare` script (keeps patch persisted after npm install)
+
+`package.json`
+ ```jsonc
+{
+  /* ... */
   "scripts": {
-    "build": "tspc -p tsconfig.json"
+    "prepare": "ts-patch install -s"
   }
-  ```
+}
+```
 
-  Build errors/warnings from the transformer will appear in the `tsc` output.
+For advanced options, see: [ts-patch docs](https://github.com/nonara/ts-patch?tab=readme-ov-file#usage)
 
 ## Configuration Options