From cc4dcdfe2fd8f78154c48a8dca27b5e393c9a3a7 Mon Sep 17 00:00:00 2001
From: Erick Zhao <erick@hotmail.ca>
Date: Fri, 14 Nov 2025 13:33:58 -0800
Subject: [PATCH] docs: update README install instructions

Changes the instructions after the Yarn v4 migration.
---
 README.md | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index da78777..0cdc6bb 100644
--- a/README.md
+++ b/README.md
@@ -8,15 +8,17 @@
 
 ## Building and Development
 
+This project uses [Yarn 4](https://yarnpkg.com/) to manage dependencies.
+
+To get started:
+
 - Clone the repository to your local machine
-- Run `npm install` to install dependencies
-- Run `npm link` to link the package globally
-- Run `npm run build` to build the project
+- Run `yarn install` to install dependencies
+- Run `yarn build` to build the project
 
-#### Configuring an Electron App to use Devtron
+### Configuring an Electron App to use Devtron
 
-- In your Electron app run `npm link @electron/devtron` to link the Devtron package
-- In your Electron app's `main.js` (or other relevant file) add the following code to load Devtron:
+- In your Electron app's main entry point, add the following code to load Devtron:
 
 ```js
 // main.js
@@ -66,7 +68,7 @@ await devtron.install({ logLevel: 'warn' });
 
 ### `await devtron.getEvents()`
 
-Returns a **promise** that resolves to the array of IPC events recorded by the Devtron service worker since installation.
+Returns a **Promise** that resolves to the array of IPC events recorded by the Devtron service worker since installation.
 
 - If the `Clear all events` button in the Devtron UI is clicked, this array will be cleared.