@falconeta/capacitor-wifi-connect - npm Package Compare versions

Comparing version 5.1.6 to 5.1.7

package.json

 {
   "name": "@falconeta/capacitor-wifi-connect",
-  "version": "5.1.6",
+  "version": "5.1.7",
   "description": "plugin used for connect the device trhought Wifi also with prefix",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

README.md

@@ -12,2 +12,23 @@ # @falconeta/capacitor-wifi-connect
 
+## Example usage
+```typescript
+import { CapacitorWifiConnect } from "@falconeta/capacitor-wifi-connect";
+
+  async secureConnect() {
+    let { value } = await CapacitorWifiConnect.checkPermission();
+    if (value === 'prompt') {
+      const data = await CapacitorWifiConnect.requestPermission();
+      value = data.value;
+    }
+    if (value === 'granted') {
+      CapacitorWifiConnect.secureConnect({
+        ssid: 'SSID', 
+        password: 'PWD', 
+      }).then((data) => alert(data.value));
+    } else {
+      throw new Error('permission denied');
+    }
+  }
+```
+
 # iOS Functions
@@ -24,2 +45,12 @@ For functionality, you need to note the following:
 
+* Will ensure that these permission are described in info.plist
+```plist
+  <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
+  <string>...</string>
+  <key>NSLocationAlwaysUsageDescription</key>
+  <string>...</string>
+  <key>NSLocationWhenInUseUsageDescription</key>
+  <string>...</string>
+  ```
+
 ## API
@@ -26,0 +57,0 @@

No alert changes

Improved metrics

Number of lines in readme file

242

increased by14.69%

Worsened metrics

Total package byte prevSize

84387

decreased by-0.03%

No dependency changes