From b4909b63bbe4be6ff1adbb0c67bc6b08a048a35f Mon Sep 17 00:00:00 2001
From: Erick Zhao <erick@hotmail.ca>
Date: Mon, 20 Apr 2026 09:38:51 -0700
Subject: [PATCH] docs: Revise README for new major version

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

diff --git a/README.md b/README.md
index 37fdc7a..08ce20e 100644
--- a/README.md
+++ b/README.md
@@ -11,13 +11,17 @@ npm install minidump
 
 ## Building (for development)
 
+`minidump` includes [`breakpad`](https://chromium.googlesource.com/breakpad/breakpad) as a git submodule.
+
 * `git clone --recurse-submodules https://github.com/electron/node-minidump`
-* `npm install`
+* `yarn install`
 
 ## Docs
 
+This package is
+
 ```javascript
-import minidump from 'minidump';
+import * as minidump from 'minidump';
 ```
 
 ### minidump.addSymbolPath(path1, ..., pathN)