Skip to content

Commit a1cf538

Browse files
committed
Modernize README.md structure
- Remove all emojis for professional appearance - Add badges for Python, Docker, releases, and license - Center all headers using HTML div alignment - Convert Docker commands list to clean table format - Separate headers from content for better readability - Maintain all existing content and wording
1 parent 563e3ef commit a1cf538

1 file changed

Lines changed: 81 additions & 35 deletions

File tree

README.md

Lines changed: 81 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,41 @@
1-
# 👻 cloudscraper-proxy
2-
3-
A simple local proxy server, powered by [cloudscraper](https://github.com/VeNoMouS/cloudscraper) library ☁️.
4-
> 💡 This allows you to easily bypass Cloudflare "restrictions" in your project, without having to add additional code
1+
<div align="center">
2+
<h1>cloudscraper-proxy</h1>
3+
<p>A simple local proxy server, powered by <a href="https://github.com/VeNoMouS/cloudscraper">cloudscraper</a> library</p>
4+
</div>
5+
6+
<p align="center">
7+
<img src="https://img.shields.io/badge/python-3.8+-blue?style=for-the-badge&logo=python&logoColor=white">
8+
<img src="https://img.shields.io/github/v/release/GhostTypes/cloudscraper-server?style=for-the-badge">
9+
<img src="https://img.shields.io/badge/docker-ready-blue?style=for-the-badge&logo=docker&logoColor=white">
10+
<img src="https://img.shields.io/github/license/GhostTypes/cloudscraper-server?style=for-the-badge">
11+
</p>
12+
13+
<div align="center">
14+
<p>This allows you to easily bypass Cloudflare "restrictions" in your project, without having to add additional code</p>
15+
</div>
516

617
---
718

8-
## 👀 See it in Action!
19+
<div align="center">
20+
<h2>See it in Action!</h2>
21+
</div>
22+
23+
**Before** (Standard request, contents blocked by Cloudflare):
924

10-
**Before** (Standard request, 🧱 contents blocked by Cloudflare):
1125
![image](https://github.com/user-attachments/assets/3ce7e244-8084-4e67-a904-e5a18d229899)
1226

13-
**After** (Using the local proxy ✅, contents accessed normally):
27+
**After** (Using the local proxy, contents accessed normally):
28+
1429
![image](https://github.com/user-attachments/assets/1b282213-6646-4011-abf0-5c19dc3de6d7)
1530

1631
---
1732

18-
## 🚀 Getting Started
33+
<div align="center">
34+
<h2>Getting Started</h2>
35+
</div>
1936

2037
1. **Modify Your Requests:**
38+
2139
Instead of directly requesting a URL like:
2240
```
2341
https://www.google.com
@@ -29,16 +47,19 @@ A simple local proxy server, powered by [cloudscraper](https://github.com/VeNoMo
2947
*(Replace `5000` if you change the default port)*
3048
3149
2. **Start the Proxy Server:**
50+
3251
Run the Python server:
3352
```bash
3453
python server.py
3554
```
3655
37-
That's it! 🎉 Your project can now make requests through the proxy.
56+
That's it! Your project can now make requests through the proxy.
3857
3958
---
4059
41-
## ⚙️ Configuration
60+
<div align="center">
61+
<h2>Configuration</h2>
62+
</div>
4263
4364
Want to change the port? Easy!
4465
@@ -47,32 +68,57 @@ Edit the `server.py` file at the bottom:
4768
if __name__ == "__main__":
4869
print('Starting Cloudflare bypass proxy server...')
4970
from waitress import serve
50-
# 👇 Change the port here
71+
# Change the port here
5172
serve(app, host="0.0.0.0", port=5000)
5273
```
5374

54-
## 🐳 Docker & Make Commands
55-
> 💡 The project includes several make commands to help manage the Docker container:
56-
```
57-
# 🏗️ Build the Docker image
58-
make build
59-
60-
# ▶️ Run the Docker container (defaults to port 5000)
61-
make run
62-
63-
# 🚀 Build and run in one go
64-
make up
65-
66-
# 🛑 Stop and remove the container
67-
make clean
68-
69-
# 📜 View container logs
70-
make logs
71-
72-
# 🔄 Restart the container
73-
make restart
75+
---
7476

75-
# 📊 Check container status
76-
make status
77-
```
78-
> 🔧 You can change the port and container settings by editing the variables at the top of the makefile.
77+
<div align="center">
78+
<h2>Docker & Make Commands</h2>
79+
</div>
80+
81+
<div align="center">
82+
<p>The project includes several make commands to help manage the Docker container</p>
83+
</div>
84+
85+
<div align="center">
86+
<table>
87+
<tr>
88+
<th>Command</th>
89+
<th>Description</th>
90+
</tr>
91+
<tr>
92+
<td><code>make build</code></td>
93+
<td>Build the Docker image</td>
94+
</tr>
95+
<tr>
96+
<td><code>make run</code></td>
97+
<td>Run the Docker container (defaults to port 5000)</td>
98+
</tr>
99+
<tr>
100+
<td><code>make up</code></td>
101+
<td>Build and run in one go</td>
102+
</tr>
103+
<tr>
104+
<td><code>make clean</code></td>
105+
<td>Stop and remove the container</td>
106+
</tr>
107+
<tr>
108+
<td><code>make logs</code></td>
109+
<td>View container logs</td>
110+
</tr>
111+
<tr>
112+
<td><code>make restart</code></td>
113+
<td>Restart the container</td>
114+
</tr>
115+
<tr>
116+
<td><code>make status</code></td>
117+
<td>Check container status</td>
118+
</tr>
119+
</table>
120+
</div>
121+
122+
<div align="center">
123+
<p>You can change the port and container settings by editing the variables at the top of the makefile.</p>
124+
</div>

0 commit comments

Comments
 (0)