From 40ce82ce7c9c00e8b6ef31a08cdba4d7b1c87cc9 Mon Sep 17 00:00:00 2001 From: isuPatches Date: Sun, 2 Jul 2017 09:38:32 -0500 Subject: [PATCH] Update README to include permission blurb --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5725e813..b1373018 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,23 @@ To grab an instance with logging enabled: WiseFy mWiseFy = new WiseFy.withContext(getActivity()).logging(true).getSmarts(); ``` +## Permissions + +For the sake of transparency and because you're probably curious as to what permissions this library adds to your app, here are the additional expected permissions: + +```xml + + + + + + +``` + + * NOTE * + +If a search for an SSID is failing (returning false or NULL depending on the method) on >= 6.x devices but the network is visible, it's most likely because you haven't asked in your application for the `Manifest.permission.ACCESS_COARSE_LOCATION` permission which is what allows us to see the access points nearby. It has been up for debate on if it would be beneficial to move permission requests to the WiseFy library, but at this time, it remains as-is so users can determine their own UI/UX and to not add additional package bloat. + ## Commands To add an open network: