Merge pull request #688 from rshah713/master

akshayaurora · web-flow · commit 2be7b318d945 · 2022-07-04T20:38:31.000+05:30
Create clear documentation for Keystore
diff --git a/README.md b/README.md
@@ -44,6 +44,7 @@ implement the api in the easiest way, depending on the current platform.
 | Gyroscope                      | ✔       | ✔   |         |      |       |
 | Humidity                       | ✔       |     |         |      |       |
 | IR Blaster                     | ✔       |     |         |      |       |
+| Keystore                       | ✔       | ✔   | ✔       | ✔    | ✔     |
 | Light                          | ✔       |     |         |      |       |
 | Native file chooser            | ✔       | ✔   | ✔       | ✔    | ✔     |
 | Notifications                  | ✔       |     | ✔       | ✔    | ✔     |
diff --git a/plyer/facades/keystore.py b/plyer/facades/keystore.py
@@ -1,9 +1,19 @@
+'''
+Keystore
+=======
+The :class:`Keystore` provides a mechanism for securing/storing cryptographic keys (such as user credentials) in a container. typically needed to support authentication APIs such as OAuth2
+.. note::
+        Typically needed to support authentication APIs such as OAuth2
+         
+Supported Platforms
+-------------------
+Android, iOS, Windows, OS X, Linux
+---------------
+'''
+
 class Keystore:
     '''
-    Keyring facade
-
-    .. versionadded:: x.x.x
-
+    Keystore facade
     '''
 
     def set_key(self, servicename, key, value, **kwargs):
