From 30f04b04f63598457f5ac13c34b239ee1d1391b6 Mon Sep 17 00:00:00 2001
From: masklinn <github.com@masklinn.net>
Date: Wed, 27 Apr 2022 16:40:21 +0200
Subject: [PATCH] Add note that the convenience parsers are not cached to
 readme

This is an intermediate stopgap before modifying caching so it works
with and across all the functions, as the issue does seem pretty
significant (cf #97)
---
 README.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.rst b/README.rst
index 10db414..1425b64 100644
--- a/README.rst
+++ b/README.rst
@@ -77,6 +77,16 @@ Extract browser data from user-agent string
     >>> pp.pprint(parsed_string)
     {'family': 'Chrome', 'major': '41', 'minor': '0', 'patch': '2272'}
 
+..
+
+    ⚠️The convenience parsers (``ParseUserAgent``, ``ParseOs``, and
+    ``ParseDevice``) currently have no caching, which can result in
+    degraded performances when parsing large amounts of identical
+    user-agents (which might occur for real-world datasets).
+
+    In that case, prefer using ``Parse`` and extracting the
+    sub-component you need from the resulting dictionary.
+
 Extract OS information from user-agent string
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~