From 79c7960668d17457d644ffc9727844523067d016 Mon Sep 17 00:00:00 2001
From: Kyle Gottfried <6462596+Spitfire1900@users.noreply.github.com>
Date: Wed, 31 Dec 2025 10:31:47 -0500
Subject: [PATCH] Update README.md - add notes about specific libraries

httpx and aiohttp set timeouts by default, worth knowing before adopting this linter.
---
 README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e7bf9a5..66364f8 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,9 @@
 
 A flake8 plugin that checks for missing `timeout` parameters in network calls.
 
-By default, the plugin checks common HTTP libraries but can be configured to track any function that accepts a timeout parameter.
+[requests](https://requests.readthedocs.io/en/latest/api/#requests.Session.request) and [urllib.request.urlopen](https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen) do not set timeouts by default unlike [httpx](https://www.python-httpx.org/advanced/timeouts/) and [aiohttp](https://docs.aiohttp.org/en/stable/client_quickstart.html#timeouts).
+
+flake8-timeout checks `requests` and `urllib.request.urlopen` calls by default but can be configured to track any function that accepts a timeout parameter.
 
 ## installation