Skip to content

Commit 0dac2b9

Browse files
authored
Update README with architecture details
Added architecture diagram and description to README.
1 parent 324a585 commit 0dac2b9

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,34 @@ Make sure no other service is using the same port. The script uses the SOCKS5_PO
6565
```bash
6666
./scripts/destroy.sh
6767
```
68+
69+
## Architecture
70+
```mermaid
71+
flowchart TD
72+
User --> CLI
73+
User --> API
74+
CLI --> Scraper
75+
API --> Scraper
76+
Scraper --> TorProxy
77+
Scraper --> HTTPClient
78+
TorProxy --> TorNetwork
79+
HTTPClient --> Internet
80+
81+
%% Node labels
82+
CLI["CLI Interface"]
83+
API["REST API"]
84+
Scraper["Web Scraper Core (Go)"]
85+
TorProxy["Tor Proxy"]
86+
HTTPClient["HTTP Client"]
87+
TorNetwork["Tor Network"]
88+
Internet["Internet"]
89+
```
90+
**Description:**
91+
- Users interact via CLI or REST API.
92+
- Both interfaces connect to the Go-based scraper core.
93+
- The scraper routes requests via Tor or standard HTTP.
94+
- Requests reach either the Tor network or the normal Internet.
95+
6896
## Documentation
6997
This project includes comprehensive code comments to facilitate documentation generation with godoc. To generate and access documentation, use the following command:
7098

0 commit comments

Comments
 (0)