From 1c25a38787becc7a84f6ddfc4d84f50ec66d5a55 Mon Sep 17 00:00:00 2001
From: Hal Blackburn <hal.blackburn@gmail.com>
Date: Thu, 29 Feb 2024 09:55:57 +0000
Subject: [PATCH] Mention type annotations in README

The README now mentions and links to the `sortedcontainers-stubs`
package, as discussed in #107.
---
 README.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.rst b/README.rst
index ba74b8c..3e24a97 100644
--- a/README.rst
+++ b/README.rst
@@ -114,6 +114,7 @@ Features
 - Developed on Python 3.10
 - Tested with CPython 3.7, 3.8, 3.9, 3.10, 3.11, 3.12 and PyPy3
 - Tested on Linux, Mac OSX, and Windows
+- Type annotations available
 
 .. image:: https://github.com/grantjenks/python-sortedcontainers/workflows/integration/badge.svg
    :target: http://www.grantjenks.com/docs/sortedcontainers/
@@ -141,6 +142,12 @@ Containers`_.
     >>> help(SortedDict)
     >>> help(SortedDict.popitem)
 
+If you'd like type annotations, they're available by installing the
+`sortedcontainers-stubs <https://pypi.org/project/sortedcontainers-stubs/>`_
+package (maintained separately, by Sorted Container's users)::
+
+    $ pip install sortedcontainers-stubs
+
 Documentation
 -------------