From 7538f37596322f682ab38e9300cb8921a802a0b9 Mon Sep 17 00:00:00 2001 From: agatha Date: Tue, 7 Nov 2023 19:02:52 -0500 Subject: [PATCH] Update documentation --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 7677f78..b2268b9 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,13 @@ if __name__ == '__main__': ``` +#### validate_socks +SOCKS5 proxies can be tested with the `validate_socks` method. The method takes a proxy +string as its only argument. It returns a `requests.Response` object if the request is successful +with no issues, otherwise it will raise an exception and the caller can decide how to proceed. + +For an example implementation, see [main.py](main.py). + ## Testing ``` pip install -r requirements.txt