Skip to content

Improve README with all modules and getting started guide#9

Merged
proxymesh merged 1 commit intomainfrom
docs/readme-improvements
Feb 3, 2026
Merged

Improve README with all modules and getting started guide#9
proxymesh merged 1 commit intomainfrom
docs/readme-improvements

Conversation

@proxymesh
Copy link
Copy Markdown
Owner

Summary

Comprehensive README update to make it clearer what this library does and how to use it.

Changes

  • Added all 7 supported libraries in a table format with links to docs
  • Explained the problem this library solves (HTTPS CONNECT tunneling headers)
  • Added quick start examples for:
    • requests
    • httpx
    • aiohttp
    • pycurl (low-level)
    • cloudscraper
  • Documented the test harness usage
  • Added badges for ReadTheDocs and PyPI
  • Improved structure with clear sections

Before/After

Before: Listed only 4 libraries, minimal examples, unclear about the actual problem being solved.

After: Lists all 7 libraries, explains the CONNECT tunneling problem, provides copy-paste examples for each major library.

- Add all 7 supported libraries in a table format
- Explain the problem this library solves (HTTPS CONNECT tunneling)
- Add quick start examples for requests, httpx, aiohttp, pycurl, cloudscraper
- Document the test harness
- Add badges for docs and PyPI
- Improve overall structure and clarity
@proxymesh proxymesh merged commit e1c8879 into main Feb 3, 2026
@proxymesh proxymesh deleted the docs/readme-improvements branch February 8, 2026 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant