Skip to content

Commit 2fcec52

Browse files
committed
readme fixes
1 parent 9efd352 commit 2fcec52

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,16 @@ Puppeteer: [rebrowser-puppeteer](https://www.npmjs.com/package/rebrowser-puppete
2020

2121
Playwright: *coming soon*
2222

23-
Here are the steps you need to follow:
23+
The easiest way to start using it is to fix your `package.json` to use new packages but keep the old name as an alias. This way, you don't need to change any source code of your automation. Here is how to do that:
24+
1. Open `package.json` and replace `"puppeteer": "^23.3.1"` and `"puppeteer-core": "^23.3.1"` with `"puppeteer": "npm:rebrowser-puppeteer@^23.3.1"` and `"puppeteer-core": "npm:rebrowser-puppeteer-core@^23.3.1"`.
25+
2. Run `npm install` (or `yarn install`)
26+
27+
Another way is to actually use new packages instead of the original one. Here are the steps you need to follow:
2428
1. Open `package.json` and replace `puppeteer` and `puppeteer-core` packages with `rebrowser-puppeteer` and `rebrowser-puppeteer-core`. Don't change versions of the packages, just replace the names.
2529
2. Run `npm install` (or `yarn install`)
2630
3. Find and replace in your scripts any mentions of `puppeteer` and `puppeteer-core` with `rebrowser-puppeteer` and `rebrowser-puppeteer-core`
27-
4. 🚀 Go to the [rebrowser-bot-detector](https://bot-detector.rebrowser.net/) page and test your patched browser.
31+
32+
🚀 That's it! Just visit the [rebrowser-bot-detector](https://bot-detector.rebrowser.net/) page and test your patched browser.
2833

2934
Our goal is to maintain and support these drop-in replacement packages with the latest versions, but we mainly focus on fresh versions, so if you're still using puppeteer 13.3.7 from the early 90s, it might be a good time to upgrade. There's a high chance that it won't really break anything as the API is quite stable over time.
3035

0 commit comments

Comments
 (0)