Skip to content

Commit 4a45f55

Browse files
authored
chore: tweak docs
1 parent c3dfdc0 commit 4a45f55

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

examples/cycletls/README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ This example demonstrates how to use the `@the-convocation/twitter-scraper/cycle
44

55
## Problem
66

7-
Twitter's authentication endpoints may be protected by Cloudflare's advanced bot detection, which analyzes TLS fingerprints to detect non-browser clients. Standard Node.js TLS handshakes can trigger `403 Forbidden` errors during login.
7+
Twitter's authentication endpoints may be protected by Cloudflare's bot detection, which analyzes TLS fingerprints to detect non-browser clients. Standard Node.js TLS handshakes can trigger `403 Forbidden` errors during login.
88

99
## Solution
1010

11-
This example uses [CycleTLS](https://github.com/Danny-Dasilva/CycleTLS), which leverages golang to mimic Chrome browser TLS fingerprints, allowing requests to pass through Cloudflare's protection.
11+
This example uses [CycleTLS](https://github.com/Danny-Dasilva/CycleTLS) to mimic Chrome browser TLS fingerprints, allowing requests to pass through Cloudflare's protection.
1212

1313
## Installation
1414

@@ -18,7 +18,7 @@ yarn install
1818

1919
## Configuration
2020

21-
Create a `.env` file in the root of the repository (two levels up) with your Twitter credentials:
21+
Create a `.env` file in this directory with your Twitter credentials:
2222

2323
```
2424
TWITTER_USERNAME=your_username
@@ -46,9 +46,3 @@ const scraper = new Scraper({
4646
```
4747

4848
This replaces the default fetch implementation with one that uses Chrome-like TLS fingerprints, bypassing Cloudflare's detection.
49-
50-
## Important Notes
51-
52-
- **Node.js only**: The `/cycletls` entrypoint requires Node.js and will not work in browsers
53-
- **Cleanup required**: Always call `cycleTLSExit()` when done to cleanup golang resources
54-
- **Optional dependency**: `cycletls` must be explicitly installed alongside the main package

0 commit comments

Comments
 (0)