From 5e5d92967672c3e2efa877a91670b47a3a7b25be Mon Sep 17 00:00:00 2001
From: imacat <imacat@mail.imacat.idv.tw>
Date: Thu, 24 Nov 2022 07:31:46 +1100
Subject: [PATCH] Added the test client instruction to README.rst.

---
 README.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.rst b/README.rst
index c984a92..3c0403a 100644
--- a/README.rst
+++ b/README.rst
@@ -187,6 +187,34 @@ protected Flask module without specifying the authentication
 mechanism.
 
 
+Writing Tests
+=============
+
+A test client that handles HTTP Digest Authentication is included.
+Example for a unittest testcase:
+
+::
+
+    from flask_digest_auth import Client
+    from flask_testing import TestCase
+    from my_app import create_app
+
+    class MyTestCase(TestCase):
+
+        def create_app(self):
+            app: Flask = create_app({
+                "SECRET_KEY": token_urlsafe(32),
+                "TESTING": True
+            })
+            app.test_client_class = Client
+            return app
+
+        def test_admin(self):
+            response = self.client.get(
+                "/admin", digest_auth=("my_name", "my_pass"))
+            self.assertEqual(response.status_code, 200)
+
+
 Copyright
 =========