Skip to content

docs: update README install instructions #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 16, 2025
Merged

docs: update README install instructions #308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down